Auto generate and publish CLI docs on each release#796
Merged
Conversation
cretz
approved these changes
Apr 29, 2025
| env: | ||
| GITHUB_TOKEN: ${{ steps.generate_token.outputs.token }} | ||
| run: | | ||
| gh workflow run update-cli-docs.yml \ |
Member
There was a problem hiding this comment.
Can you link to the PR with this workflow in it on the docs side? Just curious. I am happy to see we are delegating the generation to that workflow instead of trying to do it here and shipping data.
Contributor
Author
There was a problem hiding this comment.
Ahh yes, https://github.com/temporalio/documentation/blob/main/.github/workflows/update-cli-docs.yml. Will add to the PR desc as well
Contributor
Author
There was a problem hiding this comment.
oh sorry you asked for the PR, that should already be in the PR desc, temporalio/documentation#3525
yuandrew
added a commit
that referenced
this pull request
Jul 8, 2025
## What was changed <!-- Describe what has changed in this PR --> Target `main` branch instead of the dev branch I was using when working on the feature ## Why? <!-- Tell your future self why have you made these changes --> Fixing a bug from #796 ## Checklist <!--- add/delete as needed ---> 1. Closes <!-- add issue number here --> 2. How was this tested: <!--- Please describe how you tested your changes/how we can test them --> Untested, this path triggers on release, should be fine to wait for next release to ensure it's fixed. Not the worst case if this pipeline misses a release 3. Any docs updates needed? <!--- update README if applicable or point out where to update docs.temporal.io -->
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What was changed
Created a new Github Action that auto-generates and publishes a PR to the documentation repo with the latest generated CLI docs.
Corresponding docs side PR is already merged, temporalio/documentation#3525, and first PR of the auto-generated docs is merged in temporalio/documentation#3528.
Docs side YML: https://github.com/temporalio/documentation/blob/main/.github/workflows/update-cli-docs.yml
Why?
Makes keeping CLI docs up to date significantly easier.
Checklist
Closes
How was this tested:
Tested in this PR, but there's a small chance I missed something in the actual release trigger workflow. No way to fully test that until a new release is cut after this action is on main.