Skip to content

Add Canton release note updater#933

Draft
danielporterda wants to merge 1 commit into
mainfrom
canton-release-notes-updater
Draft

Add Canton release note updater#933
danielporterda wants to merge 1 commit into
mainfrom
canton-release-notes-updater

Conversation

@danielporterda

@danielporterda danielporterda commented Jul 1, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Add npm run update:canton-release-notes, backed by scripts/update_canton_release_notes.py, to refresh Canton release notes from upstream digital-asset/canton release-notes/*.md sources.
  • Generate an index at docs-main/global-synchronizer/release-notes/canton.mdx plus one standalone page per release under docs-main/global-synchronizer/release-notes/canton/.
  • Add Canton 3.5 release pages for 3.5.1 through 3.5.6, including the previously missing 3.5.4, 3.5.5, and 3.5.6 releases.
  • Update both Release Notes nav placements so the Canton entry expands to the generated per-release pages.
  • Wire the updater into the existing generated-docs PR orchestrator as target canton-release-notes, so scheduled/manual automation can open an isolated release-note PR.
  • Remove two stale network-variable tab paths from the shared orchestrator path set because those pages no longer exist on current main.

Refs #751.

Validation

  • SKIP_NPM_INSTALL=1 direnv exec . npm run update:canton-release-notes
  • SKIP_NPM_INSTALL=1 direnv exec . python3 -m pytest tests/test_update_canton_release_notes.py tests/test_update_generated_reference_prs.py tests/test_api_reference_navigation.py tests/test_update_generated_reference_sources.py
  • SKIP_NPM_INSTALL=1 direnv exec . python3 -m py_compile scripts/update_canton_release_notes.py scripts/update_generated_reference_prs.py scripts/summarize_version_changes.py tests/test_update_canton_release_notes.py
  • SKIP_NPM_INSTALL=1 direnv exec . jq empty package.json docs-main/docs.json
  • SKIP_NPM_INSTALL=1 direnv exec . python3 scripts/update_generated_reference_prs.py --targets canton-release-notes --dry-run
  • git diff --check

@mintlify

mintlify Bot commented Jul 1, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
cantonfoundation 🟢 Ready View Preview Jul 1, 2026, 8:47 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

Signed-off-by: danielporterda <daniel.porter@digitalasset.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant