Add Workflow and update cli documentation #6414
Open
+104
−19
Conversation
This file contains 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
grahamplata
added
the
Type:Documentation
begelundmuller
requested changes
Jan 16, 2025
cli/README.md
Outdated
| @@ -31,3 +31,5 @@ go run ./cli start dev-project | |||
| ## Generating CLI reference docs | |||
|
|
|||
| See `../docs/README.md` for details about the generated CLI reference docs. | |||
|
|
|||
| dummy cli change | |||
There was a problem hiding this comment.
Remember to remove this :)
docs/docs/dummy.md
Outdated
| title: Dummy | ||
| --- | ||
|
|
||
| # Dummy |
.github/workflows/docs-check.yml
Outdated
Comment on lines
40
to
44
| - name: Check if CLI docs need to be generated | ||
| if: ${{ steps.filter.outputs.cli == 'true' }} | ||
| run: | | ||
| echo "Changes detected in cli, generating docs" | ||
| make docs.generate |
There was a problem hiding this comment.
To avoid magic where the published docs do not match the contents of the docs directory on main, can we fail CI with an informative error if make docs.generate leads to changed files (you should be able to use Git to check if it leads to uncommitted changes)?
It's an extra manual step for the developer to run and commit make docs.generate, but it'll be good to have eyes on that during review anyway.
begelundmuller
requested changes
Jan 16, 2025
Comment on lines
+40
to
+43
| - name: Check if new files were created | ||
| if: ${{ steps.filter.outputs.cli == 'true' }} | ||
| run: | | ||
| git diff --exit-code || (echo "New files were created, please run 'make docs.generate' locally and commit the changes" && exit 1) |
There was a problem hiding this comment.
Is this missing the actual make docs.generate? Like:
Suggested change
| - name: Check if new files were created | |
| if: ${{ steps.filter.outputs.cli == 'true' }} | |
| run: | | |
| git diff --exit-code || (echo "New files were created, please run 'make docs.generate' locally and commit the changes" && exit 1) | |
| - name: Check if new files were created | |
| if: ${{ steps.filter.outputs.cli == 'true' }} | |
| run: | | |
| make docs.generate | |
| git diff --exit-code || (echo "New files were created, please run 'make docs.generate' locally and commit the changes" && exit 1) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Update GitHub docs workflow to check if there were cli help menu changes.