Skip to content

docs: fix release-notes frontmatter from cubic review#9982

Merged
fatih-acar merged 1 commit into
stablefrom
fac/fix-release-notes-frontmatter
Jul 21, 2026
Merged

docs: fix release-notes frontmatter from cubic review#9982
fatih-acar merged 1 commit into
stablefrom
fac/fix-release-notes-frontmatter

Conversation

@fatih-acar

@fatih-acar fatih-acar commented Jul 21, 2026

Copy link
Copy Markdown
Contributor

Addresses the cubic review on #9978 — the release-notes description frontmatter that the backfill drafted (added on stable) had several content errors, plus two robustness gaps in the backfill script. Fixing at the source (stable) so the corrections propagate to develop on the next sync.

Frontmatter description fixes

File Fix
release-1_1_2.mdx INFRAHUBPUBLICURLINFRAHUB_PUBLIC_URL
release-1_1_6.mdx typo copcopy
release-1_2_1.mdx INFRAHUBSCHEMASTRICTMODEINFRAHUB_SCHEMA_STRICT_MODE
release-1_2_9.mdx INFRAHUBTESTINGSCHEMASTRICTMODE / INFRAHUBSCHEMASTRICTMODE → underscored names
release-1_3_1.mdx minvalue/maxvalue/excludedvaluesmin_value/max_value/excluded_values
release-1_3_3.mdx drop leaked <!-- vale off --> directive from the description
release-1_4_3.mdx add missing sentence break (healthy. In the UI)
release-1_5_0.mdx replace generic placeholder (identical to 1.4.0's) with a release-specific summary

Release-date correction (1.8.0)

  • release-1_8_0.mdx: release_date corrected to 2026-03-16 (frontmatter + body table), matching the infrahub-v1.8.0 git tag. It was recorded as 2026-03-22.
  • 1.8.1 is left unchanged (2026-03-19, matching infrahub-v1.8.1). cubic flagged 1.8.1 as chronologically impossible, but that was a consequence of the wrong 1.8.0 date — with 1.8.0 corrected to 03-16, the 1.8.0 → 1.8.1 → 1.8.2 (03-25) order is consistent.

Backfill script (backfill-release-frontmatter.mjs)

  • --check now fails on files with no frontmatter block (previously skipped with a warning, so CI could pass on the most incomplete files).
  • Descriptions are serialized with JSON.stringify so backslashes/quotes stay valid YAML (the old quoted interpolation only escaped ").

Validation

  • node scripts/backfill-release-frontmatter.mjs --check — passes.
  • Frontmatter of every edited file parses as valid YAML.
  • node --check on the script passes.

🤖 Generated with Claude Code


Summary by cubic

Fixes frontmatter errors in release notes and corrects the 1.8.0 release date. Hardens the backfill script to fail on missing frontmatter and output YAML-safe descriptions.

  • Bug Fixes
    • Corrected env var/parameter names and typos in release descriptions (1.1.2, 1.1.6, 1.2.1, 1.2.9, 1.3.1, 1.3.3, 1.4.3, 1.5.0).
    • Set 1.8.0 release_date to 2026-03-16 in frontmatter and the table.
    • docs/scripts/backfill-release-frontmatter.mjs: --check now fails on files without frontmatter; descriptions use JSON.stringify for YAML-safe escaping.

Written for commit 6f02322. Summary will update on new commits.

Review in cubic

Addresses the cubic review on #9978:

- Correct env-var / parameter names missing underscores in release
  descriptions: 1.1.2 INFRAHUB_PUBLIC_URL; 1.2.1 and 1.2.9
  INFRAHUB_SCHEMA_STRICT_MODE / INFRAHUB_TESTING_SCHEMA_STRICT_MODE;
  1.3.1 min_value/max_value/excluded_values.
- Fix description typos: 1.1.6 "cop" -> "copy"; 1.4.3 missing sentence
  break; 1.3.3 drop the leaked "<!-- vale off -->" directive.
- 1.5.0: replace the generic placeholder description (identical to
  1.4.0's) with a release-specific summary.
- 1.8.0: correct release_date to 2026-03-16 to match the infrahub-v1.8.0
  tag, in both frontmatter and the body table. 1.8.1 (2026-03-19) was
  already correct and is left unchanged; cubic's suggestion to change
  1.8.1 was based on the wrong 1.8.0 date.
- backfill-release-frontmatter.mjs: make --check fail on files with no
  frontmatter block, and serialize descriptions via JSON.stringify so
  backslashes/quotes stay valid YAML.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@github-actions github-actions Bot added the type/documentation Improvements or additions to documentation label Jul 21, 2026

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 10 files

Confidence score: 5/5

  • Automated review surfaced no issues in the provided summaries.
  • No files require special attention.

Shadow auto-approve: would auto-approve. Fixes frontmatter typos and env-var names in release notes, corrects a release date, and hardens a validation script. All changes are bounded and clearly beneficial.

Re-trigger cubic

@fatih-acar
fatih-acar marked this pull request as ready for review July 21, 2026 06:34
@fatih-acar
fatih-acar requested review from a team as code owners July 21, 2026 06:34
@fatih-acar
fatih-acar enabled auto-merge (rebase) July 21, 2026 06:34
@fatih-acar
fatih-acar merged commit 763a568 into stable Jul 21, 2026
48 checks passed
@fatih-acar
fatih-acar deleted the fac/fix-release-notes-frontmatter branch July 21, 2026 08:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

type/documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants