Skip to content

Add external snippet generated docs automation#860

Draft
danielporterda wants to merge 31 commits into
mainfrom
generated-docs-external-snippets-automation
Draft

Add external snippet generated docs automation#860
danielporterda wants to merge 31 commits into
mainfrom
generated-docs-external-snippets-automation

Conversation

@danielporterda

Copy link
Copy Markdown
Contributor

Follow-on to #796. This pulls the external-snippet generated-docs automation out of the core generated-docs automation PR so it can be reviewed separately.

Scope:

  • adds the external snippet source manifest for Canton, CN Quickstart, Daml, Daml Shell, DPM, Scribe, and Splice
  • adds the per-source external snippet target runner for GitHub Actions
  • registers external snippet generated-doc targets in the orchestrator
  • keeps Canton snippets behind the heavy-runner opt-in and skips unavailable private Daml Shell/Scribe sources
  • normalizes copied generated .mdx snippet output before committing generated PR branches
  • preserves authored Splice common/** wrapper snippets while replacing generated snippet output

Validation:

  • direnv exec . python3 -m pytest tests/test_generate_external_snippet_target.py tests/test_generate_external_snippets.py tests/test_update_generated_reference_prs.py tests/test_summarize_version_changes.py (45 passed)
  • direnv exec . python3 -m py_compile scripts/generate_external_snippet_target.py scripts/generate_external_snippets.py scripts/update_generated_reference_prs.py scripts/summarize_version_changes.py
  • git diff --cached --check

danielporterda and others added 30 commits June 17, 2026 16:21
Signed-off-by: danielporterda <daniel.porter@digitalasset.com>
Signed-off-by: danielporterda <daniel.porter@digitalasset.com>
Signed-off-by: danielporterda <daniel.porter@digitalasset.com>
Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Signed-off-by: danielporterda <daniel.porter@digitalasset.com>
Signed-off-by: danielporterda <daniel.porter@digitalasset.com>
Signed-off-by: danielporterda <daniel.porter@digitalasset.com>
Signed-off-by: danielporterda <daniel.porter@digitalasset.com>
Signed-off-by: danielporterda <daniel.porter@digitalasset.com>
Signed-off-by: danielporterda <daniel.porter@digitalasset.com>
Signed-off-by: danielporterda <daniel.porter@digitalasset.com>
Signed-off-by: danielporterda <daniel.porter@digitalasset.com>
Signed-off-by: danielporterda <daniel.porter@digitalasset.com>
Signed-off-by: danielporterda <daniel.porter@digitalasset.com>
Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Signed-off-by: danielporterda <daniel.porter@digitalasset.com>
Signed-off-by: danielporterda <daniel.porter@digitalasset.com>
Signed-off-by: danielporterda <daniel.porter@digitalasset.com>
Signed-off-by: danielporterda <daniel.porter@digitalasset.com>
Signed-off-by: danielporterda <daniel.porter@digitalasset.com>
@danielporterda danielporterda force-pushed the remaining-generated-reference-pr-targets branch from 9970797 to a95495a Compare June 25, 2026 13:22
Base automatically changed from remaining-generated-reference-pr-targets to main June 25, 2026 16:20
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