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

yaml
# yaml-language-server: $schema=https://slide-spec.dev/schema/generated.schema.json
schemaVersion: 1
generated:
  id: 2026-spring-briefing
FieldRequiredTypeDescription
schemaVersionyesnumberMajor schema version. Must be 1 for this Slide Spec release.
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

Required array of release objects.

generated.releases[]

FieldRequiredTypeNotes
idyesstringUnique release id, usually the tag name. Used by timeline slides to match entries.
versionyesstringDisplay version string. The CLI currently sets this to the release tag name.
published_atyesstringPublication timestamp. The CLI emits an ISO-like UTC string.
urlyesstringLink to the release page.
summary_bulletsyesstring[]Short summary bullets shown on the slide. The CLI limits this to a small list of bullet strings.

generated.contributors

FieldRequiredType
totalyesnumber
authorsyesarray

total is the number of unique authors in the current reporting period.

generated.contributors.authors[]

FieldRequiredTypeNotes
loginyesstringGitHub username or handle. Used for profile links and contributor matching.
nameyesstringDisplay name. The CLI falls back to the login when GitHub does not provide a name.
avatar_urlyesstringAvatar image URL. The CLI falls back to a GitHub avatar URL when needed.
merged_prsyesnumberNumber of merged pull requests attributed to this contributor in the reporting period.
first_timeyesbooleanWhether this contributor had no merged PR history before the current period.

generated.merged_prs

Optional. If present, it must be an array of merged pull request entries.

generated.merged_prs[]

FieldRequiredTypeNotes
numberyesnumberPull request number.
titleyesstringPull request title.
merged_atyesstringMerge timestamp. The CLI emits an ISO-like UTC string.
author_loginyesstringAuthor's GitHub 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
  • generated.releases is required even when it is an empty array
  • generated.contributors.authors is required even when it is an empty array
  • generated.previous_presentation_id is optional and only present when a previous period exists
  • generated.merged_prs is optional and omitted when the CLI does not include historical merged PR data
  • This file does not have to come from a connector - hand-author it with data from any source