Skip to content

generated.yaml

Generated data for a presentation - metrics, releases, and contributors. Populated by a connector or authored by hand.

For a complete example, see the reference generated.yaml.

Top level

FieldRequiredTypeDescription
generated.idyesstringMust match the presentation id
generated.periodyesobjectReporting period
generated.statsyesobjectMetric values keyed by id
generated.releasesyesarrayRelease entries
generated.contributorsyesobjectContributor data
generated.previous_presentation_idstringLinks to the prior presentation for comparison
generated.merged_prsarrayMerged pull request entries

generated.period

FieldRequiredType
startyesstring
endyesstring

generated.stats

An object where each key is a metric id (e.g. stars, issues_closed, stories_completed). Key names are arbitrary - use whatever fits your data. Each value:

FieldRequiredType
labelyesstring
currentyesnumber
previousyesnumber
deltayesnumber
metadatayesobject

metadata

FieldRequiredTypeValues
comparison_statusyesstringcomplete, partial, skipped, unavailable
warning_codesyesstring[]Empty array when no warnings

Example:

yaml
generated:
  stats:
    stars:
      label: GitHub Stars
      current: 1840
      previous: 1760
      delta: 80
      metadata:
        comparison_status: complete
        warning_codes: []

generated.releases

Array of release objects. The validator checks that releases is an array. Expected shape for each entry:

FieldDescription
idUnique release id (referenced by timeline slides)
versionDisplay version string
published_atPublication date
urlLink to the release
summary_bulletsArray of summary strings

generated.contributors

FieldRequiredType
totalyesnumber
authorsyesarray

The validator checks structure only. Expected shape for each author:

FieldDescription
loginUsername or handle
nameDisplay name
avatar_urlAvatar image URL
merged_prsNumber of merged PRs or completed items
first_timeWhether this is a first-time contributor

generated.merged_prs

Optional. If present, must be an array. Expected shape per entry:

FieldDescription
numberItem number
titleItem title
merged_atCompletion date
author_loginAuthor's username

Notes

  • The id in generated.yaml must match the presentation's id
  • Keep metric keys aligned with stat_keys in any metrics-and-links slide that references them
  • This file does not have to come from a connector - hand-author it with data from any source