-
Notifications
You must be signed in to change notification settings - Fork 1
Add automation around generating CLI and config #14
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -18,4 +18,4 @@ updates: | |
| open-pull-requests-limit: 5 | ||
| commit-message: | ||
| prefix: "actions" | ||
| include: "scope" | ||
| include: "scope" | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,95 @@ | ||
| name: Update Reference Documentation | ||
|
|
||
| on: | ||
| # schedule: | ||
| # # Run daily at 2 AM UTC | ||
| # - cron: '0 2 * * *' | ||
| workflow_dispatch: | ||
| push: | ||
| branches: | ||
| - main | ||
| paths: | ||
| - 'scripts/generate_reference_*' | ||
| - 'tasks.d/generate.yaml' | ||
|
|
||
| permissions: | ||
| contents: write | ||
| pull-requests: write | ||
|
|
||
| jobs: | ||
| update-docs: | ||
| name: Update Reference Documentation | ||
| runs-on: ubuntu-latest | ||
|
|
||
| steps: | ||
| - name: Checkout | ||
| uses: actions/checkout@v5 | ||
| with: | ||
| submodules: true | ||
| persist-credentials: false | ||
| token: ${{ secrets.GITHUB_TOKEN }} | ||
|
|
||
| - name: Bootstrap environment | ||
| uses: ./.github/actions/bootstrap | ||
|
|
||
| - name: Generate reference documentation | ||
| run: | | ||
| echo "Generating reference documentation..." | ||
| .tool/task generate:reference | ||
|
|
||
| - name: Check for changes | ||
| id: check-changes | ||
| run: | | ||
| git config --local user.email "action@github.com" | ||
| git config --local user.name "GitHub Action" | ||
|
|
||
| if git diff --quiet content/docs/reference/commands/; then | ||
| echo "No changes detected" | ||
| echo "has-changes=false" >> $GITHUB_OUTPUT | ||
| else | ||
| echo "Changes detected in reference documentation" | ||
| echo "has-changes=true" >> $GITHUB_OUTPUT | ||
|
|
||
| # Show what changed | ||
| echo "Changed files:" | ||
| git diff --name-only content/docs/reference/commands/ | ||
|
|
||
| # Show diff stats | ||
| echo "Diff summary:" | ||
| git diff --stat content/docs/reference/commands/ | ||
| fi | ||
|
|
||
| - uses: tibdex/github-app-token@3beb63f4bd073e61482598c45c71c1019b59b73a #v2.1.0 | ||
| id: generate-token | ||
| with: | ||
| app_id: ${{ secrets.TOKEN_APP_ID }} | ||
| private_key: ${{ secrets.TOKEN_APP_PRIVATE_KEY }} | ||
|
|
||
| - name: Create Pull Request | ||
| if: steps.check-changes.outputs.has-changes == 'true' | ||
| uses: peter-evans/create-pull-request@271a8d0340265f705b14b6d32b9829c1cb33d45e # v7.0.8 | ||
| with: | ||
| token: ${{ steps.generate-token.outputs.token }} | ||
| signoff: true | ||
| commit-message: | | ||
| Update cli/config reference documentation (auto generated) | ||
| title: "📚 Update cli/config reference documentation" | ||
| body: | | ||
| ## 🤖 Automated Reference Documentation Update | ||
|
|
||
| This PR contains automatic updates to the reference documentation generated from the latest container images. | ||
|
|
||
| ### Changes Include: | ||
| - Updated CLI command documentation | ||
| - Updated configuration documentation | ||
| - Latest version information and help text | ||
|
|
||
| ⚡ This PR was automatically generated by the `update-reference-docs` workflow. | ||
| branch: update-reference-docs-${{ github.run_number }} | ||
| branch-suffix: timestamp | ||
| labels: | | ||
| documentation | ||
| automated | ||
| reference | ||
| draft: false | ||
| delete-branch: true | ||
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1 @@ | ||
| rules: | ||
| rules: |
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -31,4 +31,4 @@ | |
| "MD050": { | ||
| "style": "asterisk" | ||
| } | ||
| } | ||
| } | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,93 @@ | ||
| # the default is to run these on commit + push | ||
| default_stages: | ||
| - pre-push | ||
|
|
||
| repos: | ||
| # Universal repository concerns (not stack-specific) | ||
| - repo: https://github.com/pre-commit/pre-commit-hooks | ||
| rev: v2.4.0 | ||
| hooks: | ||
| # prevent giant files from being committed | ||
| - id: check-added-large-files | ||
| stages: | ||
| - pre-push | ||
|
|
||
| # checks for a common error of placing code before the docstring | ||
| - id: check-docstring-first | ||
| stages: | ||
| - pre-push | ||
|
|
||
| # attempts to load all yaml files to verify syntax | ||
| - id: check-yaml | ||
| stages: | ||
| - pre-push | ||
|
|
||
| # attempts to load all json files to verify syntax | ||
| - id: check-json | ||
| stages: | ||
| - pre-push | ||
|
|
||
| # makes sure files end in a newline and only a newline | ||
| - id: end-of-file-fixer | ||
| exclude: '^tests/(fixtures|snapshots)/' | ||
| stages: | ||
| - pre-push | ||
|
|
||
| # trims trailing whitespace | ||
| - id: trailing-whitespace | ||
| stages: | ||
| - pre-push | ||
|
|
||
| # check for files that contain merge conflict strings | ||
| - id: check-merge-conflict | ||
| stages: | ||
| - pre-push | ||
|
|
||
| # simply check whether files parse as valid python | ||
| - id: check-ast | ||
| stages: | ||
| - pre-push | ||
|
|
||
| # check for files with names that would conflict on a case-insensitive filesystem like MacOS HFS+ or Windows FAT | ||
| - id: check-case-conflict | ||
| stages: | ||
| - pre-push | ||
|
|
||
| # # GitHub Actions linting | ||
| # - repo: https://github.com/zizmorcore/zizmor-pre-commit | ||
| # rev: v1.12.1 | ||
| # hooks: | ||
| # - id: zizmor | ||
|
|
||
| # Stack-specific hooks (delegates to task namespaces) | ||
| - repo: local | ||
| hooks: | ||
| # Hugo/Node stack | ||
| - id: hugo-lint-fix | ||
| name: hugo-lint-fix | ||
| entry: make hugo:lint-fix | ||
| pass_filenames: false | ||
| language: system | ||
| files: \.(md|html|yaml|toml|css|js)$ | ||
|
|
||
| # Python stack | ||
| - id: python-lint-fix | ||
| name: python-lint-fix | ||
| entry: make python:lint-fix | ||
| pass_filenames: false | ||
| language: system | ||
| files: \.py$ | ||
|
|
||
| - id: python-format | ||
| name: python-format | ||
| entry: make python:format | ||
| pass_filenames: false | ||
| language: system | ||
| files: \.py$ | ||
|
|
||
| - id: python-types | ||
| name: python-types | ||
| entry: make python:check-types | ||
| pass_filenames: false | ||
| language: system | ||
| files: \.py$ |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -29,4 +29,4 @@ content/docs/releases/*/v*.md | |
| *.woff | ||
| *.woff2 | ||
| *.ttf | ||
| *.eot | ||
| *.eot | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -37,4 +37,4 @@ $(TASKS): $(TASK) | |
| @$(TASK) $@ | ||
|
|
||
| help: $(TASK) | ||
| @$(TASK) -l | ||
| @$(TASK) -l | ||
Oops, something went wrong.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.