Skip to main content
Version: v0.29.0

Regis Well-Known Metadata

Title: Regis Well-Known Metadata

Typeobject
Additional propertiesAny type: allowed

Description: Standard metadata fields recognized by regis across all playbooks.

PropertyPatternTypeDeprecatedDefinitionTitle/Description
- ci.platformNoenum (of string)No-CI platform running the analysis
- ci.job.idNostringNo-Unique identifier of the CI job
- ci.job.urlNostringNo-URL to the CI job run
- NoobjectNo--

1. Optional Property ci.platform

Typeenum (of string)

Description: CI platform running the analysis

Must be one of:

  • "github"
  • "gitlab"

2. Optional Property ci.job.id

Typestring

Description: Unique identifier of the CI job

3. Optional Property ci.job.url

Typestring
Formaturi

Description: URL to the CI job run


Generated using json-schema-for-humans on 2026-04-22 at 19:43:55 +0000

  • 1. Optional Property ci.platform
  • 2. Optional Property ci.job.id
  • 3. Optional Property ci.job.url