Skip to content

Automate generated docs update#796

Merged
hrischuk-da merged 35 commits into
mainfrom
remaining-generated-reference-pr-targets
Jun 25, 2026
Merged

Automate generated docs update#796
hrischuk-da merged 35 commits into
mainfrom
remaining-generated-reference-pr-targets

Conversation

@danielporterda

@danielporterda danielporterda commented Jun 17, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Summary:

  • Adds scheduled automation that checks all non-snippet generated docs surfaces for upstream/source changes and opens or updates one draft generated-output PR per target.
  • Adds coverage for Splice OpenAPI, JSON Ledger API OpenAPI/AsyncAPI, gRPC Ledger API, Canton protobuf history, Java ledger bindings, Daml Standard Library, TypeScript bindings, Canton metrics, and the version dashboard.

These automations need seasoning, but we should merge them in now so we can observe how they behave over time

danielporterda and others added 9 commits June 17, 2026 16:21
@danielporterda
Automate TypeScript bindings updates
add2cb9 
Signed-off-by: danielporterda <daniel.porter@digitalasset.com>
@danielporterda
Update TypeScript bindings reference
a853200 
Signed-off-by: danielporterda <daniel.porter@digitalasset.com>
@danielporterda
Add remaining generated reference PR targets
7a41d89 
Signed-off-by: danielporterda <daniel.porter@digitalasset.com>
@github-actions
Fix JSON API generated PR target paths
fd010dc 
Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
@github-actions
Support products nav for AsyncAPI generation
999c371 
Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
@github-actions
Write AsyncAPI nav scratch under docs root
a91bf0c 
Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
@github-actions
Support products nav for Java and Daml reference generation
8c28014 
Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
@github-actions
Add Java binding statuses for 3.5
5fb5c28 
Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
@github-actions
Fix DPM damlc resolution for Daml stdlib docs
069de64 
Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
@danielporterda danielporterda self-assigned this Jun 18, 2026
@github-actions
Cover all generated docs in update automation
0678697 
Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
@danielporterda danielporterda force-pushed the remaining-generated-reference-pr-targets branch from a8ac52c to 0678697 Compare June 18, 2026 13:15
@danielporterda
Use public Canton sources for generated docs automation
5ced92c 
Signed-off-by: danielporterda <daniel.porter@digitalasset.com>
@danielporterda danielporterda force-pushed the remaining-generated-reference-pr-targets branch from f70a469 to 5ced92c Compare June 18, 2026 13:29
@danielporterda danielporterda changed the title Add remaining generated reference PR targets Add remaining generated docs PR targets Jun 18, 2026
@danielporterda
Install Daml tooling for generated docs workflow
4cb0497 
Signed-off-by: danielporterda <daniel.porter@digitalasset.com>
@danielporterda
Unset CI for Canton metrics generation
4eab5a0 
Signed-off-by: danielporterda <daniel.porter@digitalasset.com>
@danielporterda
Right-size Canton external snippet heap
660e4f2 
Signed-off-by: danielporterda <daniel.porter@digitalasset.com>
@danielporterda
Gate heavy external snippet targets
59e0067 
Signed-off-by: danielporterda <daniel.porter@digitalasset.com>
@danielporterda
Make generated docs workflow setup explicit
5249930 
Signed-off-by: danielporterda <daniel.porter@digitalasset.com>
@danielporterda
Normalize external snippet markdown output
f3a9ca0 
Signed-off-by: danielporterda <daniel.porter@digitalasset.com>
@danielporterda
Skip regeneration when source pins are unchanged
e93b744 
Signed-off-by: danielporterda <daniel.porter@digitalasset.com>
@danielporterda
Keep dashboard and network tabs in one generated PR
f735e3f 
Signed-off-by: danielporterda <daniel.porter@digitalasset.com>
@danielporterda danielporterda force-pushed the remaining-generated-reference-pr-targets branch from f2d8458 to f735e3f Compare June 18, 2026 20:42
danielporterda and others added 6 commits June 18, 2026 16:43
@danielporterda
Allow targeted generated docs workflow dispatch
5f110e2 
Signed-off-by: danielporterda <daniel.porter@digitalasset.com>
@github-actions
Update generated docs (#810)
b07a8c3 
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>
@github-actions
Avoid checking out generated PR branches
7231044 
Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
@github-actions
Fully qualify generated branch push refs
7edf758 
Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
@github-actions
Remove generated output from automation PR
06e029d 
Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
@github-actions
Authenticate Splice OpenAPI release lookups
5761ac9 
Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
@github-actions
Remove TypeScript generated output from automation PR
878ed64 
Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
@danielporterda danielporterda changed the title Add remaining generated docs PR targets Complete generated docs update automation Jun 22, 2026
@danielporterda danielporterda changed the base branch from typescript-bindings-update-automation to main June 22, 2026 20:47
@danielporterda danielporterda mentioned this pull request Jun 22, 2026
Closed
@danielporterda
Fix generated docs target output blockers
51e29ee 
Signed-off-by: danielporterda <daniel.porter@digitalasset.com>
@danielporterda
Close stale generated docs PRs for no-op targets
d3063e3 
Signed-off-by: danielporterda <daniel.porter@digitalasset.com>
@danielporterda
Delete stale generated docs branches on no-op cleanup
db67dc7 
Signed-off-by: danielporterda <daniel.porter@digitalasset.com>
@danielporterda
Split external snippet automation into follow-on
8220d36 
Signed-off-by: danielporterda <daniel.porter@digitalasset.com>
@danielporterda danielporterda mentioned this pull request Jun 23, 2026
Draft
@danielporterda danielporterda force-pushed the remaining-generated-reference-pr-targets branch from 68dd35c to 9970797 Compare June 25, 2026 13:22
@danielporterda
Run generated docs automation every 30 minutes
a95495a 
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
@danielporterda danielporterda changed the title Complete generated docs update automation Automate generated docs update Jun 25, 2026
@danielporterda danielporterda marked this pull request as ready for review June 25, 2026 13:31
hrischuk-da
hrischuk-da reviewed Jun 25, 2026
View reviewed changes
Comment thread config/x2mdx/grpc-ledger-api-reference/source-artifacts.json
"release_url_template": "https://www.canton.io/releases/canton-open-source-{version}.tar.gz",
"bundle_proto_dir": "protobuf",
"repo": {
"remote": "https://github.com/DACH-NY/canton.git",

@hrischuk-da hrischuk-da Jun 25, 2026

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.

@danielporterda did you confirm with @soren-da that all canton updates are pushed to the OSS version?

@danielporterda danielporterda Jun 25, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

yes, confirmed via slack.

hrischuk-da
hrischuk-da reviewed Jun 25, 2026
View reviewed changes
Comment thread config/x2mdx/ledger-bindings/source-artifacts.json Outdated
@danielporterda @github-actions
Restore broad Java bindings package filter
55614c3 
Signed-off-by: danielporterda <daniel.porter@digitalasset.com>
@danielporterda
Remove JVM docs status manifests
bf3fd17 
Signed-off-by: danielporterda <daniel.porter@digitalasset.com>
@danielporterda
Merge branch 'main' into remaining-generated-reference-pr-targets
129d310
@hrischuk-da hrischuk-da merged commit ebf0bff into main Jun 25, 2026
3 checks passed
@hrischuk-da hrischuk-da deleted the remaining-generated-reference-pr-targets branch June 25, 2026 16:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@hrischuk-da hrischuk-da hrischuk-da approved these changes

Assignees

@danielporterda danielporterda

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@danielporterda @hrischuk-da