-
Notifications
You must be signed in to change notification settings - Fork 0
chore(ci): add a workflow to auto-commit docs changes #59
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
Draft
ctreatma
wants to merge
5
commits into
main
Choose a base branch
from
auto-update-docs
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
5fe642c
chore(ci): auto-commit docs updates for Renovate PRs
ctreatma e35bd38
TEMP: change author_check to see how execution changes
ctreatma ef64722
TEMP debug
ctreatma 79b2be2
TEMP upgrade SDK to trigger docs regeneration
ctreatma 7b2dd8a
chore(docs): automated commit of updated documentation
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,18 +2,35 @@ on: | |
| pull_request: | ||
|
|
||
| permissions: | ||
| contents: read | ||
| contents: write | ||
| pull-requests: write | ||
|
|
||
| jobs: | ||
| validate_docs: | ||
| name: Validate CLI Docs | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Determine if PR is from Renovate | ||
| id: author_check | ||
| run: | | ||
| is_renovate=${{github.actor == 'ctreatma' && startsWith(github.head_ref, 'auto')}} | ||
| echo "is_renovate=$is_renovate" | tee $GITHUB_OUTPUT | ||
|
|
||
|
|
||
| - name: Debug step outputs | ||
| run: echo "${{ toJSON(steps.author_check) }}" | ||
|
|
||
| - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1 | ||
| if: steps.author_check.outputs.is_renovate != 'true' | ||
| with: | ||
| fetch-depth: 1 | ||
|
|
||
| # If this is a Renovate PR, check out the PR head ref so we can commit and push | ||
| - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1 | ||
| if: steps.author_check.outputs.is_renovate == 'true' | ||
| with: | ||
| ref: ${{ github.event.pull_request.head.ref }} | ||
|
|
||
| - name: Set up Go | ||
| uses: actions/setup-go@4dc6199c7b1a012772edbd06daecab0f50c9053c # v6.1.0 | ||
| with: | ||
|
|
@@ -26,8 +43,26 @@ jobs: | |
| id: validate_docs | ||
| run: make docs-check | ||
|
|
||
| # Push docs changes to Renovate PRs since Renovate | ||
| # can't respond to comments | ||
| - if: | | ||
| always() && | ||
| steps.author_check.outputs.is_renovate == 'true' && | ||
| steps.validate_docs.outcome == 'failure' | ||
| run: | | ||
| git config --global user.name 'equinix-labs@auto-commit-workflow' | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. fwiw - the repo org is |
||
| git config --global user.email 'bot@equinix.noreply.github.com' | ||
| git add docs | ||
| git commit -m "chore(docs): automated commit of updated documentation" || echo "No changes to commit" | ||
| git push | ||
|
|
||
| # Post a sticky comment on non-Renovate PRs to direct | ||
| # contributors to update docs when needed | ||
| - uses: marocchino/sticky-pull-request-comment@773744901bac0e8cbb5a0dc842800d45e9b2b405 # v2.9.4 | ||
| if: always() && (steps.validate_docs.outcome == 'failure') | ||
| if: | | ||
| always() && | ||
| steps.author_check.outputs.is_renovate == 'false' && | ||
| (steps.validate_docs.outcome == 'failure') | ||
| with: | ||
| header: pr-docs-error | ||
| message: | | ||
|
|
||
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 |
|---|---|---|
|
|
@@ -5,7 +5,6 @@ on: | |
| types: | ||
| - opened | ||
| - edited | ||
| - synchronize | ||
|
|
||
| permissions: | ||
| pull-requests: write | ||
|
|
||
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 |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| ## equinix fabricv4 agent-templates | ||
|
|
||
| Manage agent-templates resources | ||
|
|
||
| ### Synopsis | ||
|
|
||
| Commands for managing agent-templates resources in the API | ||
|
|
||
| ### Options | ||
|
|
||
| ``` | ||
| -h, --help help for agent-templates | ||
| ``` | ||
|
|
||
| ### Options inherited from parent commands | ||
|
|
||
| ``` | ||
| --config string config file (default is $HOME/.config/equinix/equinix.yaml) | ||
| --debug Enable debug logging for HTTP requests | ||
| -f, --format string Format to use for output (json or yaml) (default "json") | ||
| ``` | ||
|
|
||
| ### SEE ALSO | ||
|
|
||
| * [equinix fabricv4](equinix_fabricv4.md) - Manage Equinix fauricv4 resources | ||
| * [equinix fabricv4 agent-templates get-agent-template-by-uuid](equinix_fabricv4_agent-templates_get-agent-template-by-uuid.md) - Execute get-agent-template-by-uuid operation | ||
| * [equinix fabricv4 agent-templates get-agent-templates](equinix_fabricv4_agent-templates_get-agent-templates.md) - Execute get-agent-templates operation | ||
|
|
39 changes: 39 additions & 0 deletions
39
docs/equinix_fabricv4_agent-templates_get-agent-template-by-uuid.md
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,39 @@ | ||
| ## equinix fabricv4 agent-templates get-agent-template-by-uuid | ||
|
|
||
| Execute get-agent-template-by-uuid operation | ||
|
|
||
| ### Synopsis | ||
|
|
||
| Execute the get-agent-template-by-uuid operation on this service. | ||
|
|
||
| Use --request flag to provide a JSON payload for the request body. | ||
| Example: --request '{"field":"value"}' | ||
|
|
||
| The command accepts parameters based on the SDK method signature. | ||
|
|
||
| ``` | ||
| equinix fabricv4 agent-templates get-agent-template-by-uuid [flags] | ||
| ``` | ||
|
|
||
| ### Options | ||
|
|
||
| ``` | ||
| -h, --help help for get-agent-template-by-uuid | ||
| --limit int limit field | ||
| --offset int offset field | ||
| --request string JSON payload for additional optional fields not exposed as flags | ||
| --uuid string uuid (required) | ||
| ``` | ||
|
|
||
| ### Options inherited from parent commands | ||
|
|
||
| ``` | ||
| --config string config file (default is $HOME/.config/equinix/equinix.yaml) | ||
| --debug Enable debug logging for HTTP requests | ||
| -f, --format string Format to use for output (json or yaml) (default "json") | ||
| ``` | ||
|
|
||
| ### SEE ALSO | ||
|
|
||
| * [equinix fabricv4 agent-templates](equinix_fabricv4_agent-templates.md) - Manage agent-templates resources | ||
|
|
38 changes: 38 additions & 0 deletions
38
docs/equinix_fabricv4_agent-templates_get-agent-templates.md
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,38 @@ | ||
| ## equinix fabricv4 agent-templates get-agent-templates | ||
|
|
||
| Execute get-agent-templates operation | ||
|
|
||
| ### Synopsis | ||
|
|
||
| Execute the get-agent-templates operation on this service. | ||
|
|
||
| Use --request flag to provide a JSON payload for the request body. | ||
| Example: --request '{"field":"value"}' | ||
|
|
||
| The command accepts parameters based on the SDK method signature. | ||
|
|
||
| ``` | ||
| equinix fabricv4 agent-templates get-agent-templates [flags] | ||
| ``` | ||
|
|
||
| ### Options | ||
|
|
||
| ``` | ||
| -h, --help help for get-agent-templates | ||
| --limit int limit field | ||
| --offset int offset field | ||
| --request string JSON payload for additional optional fields not exposed as flags | ||
| ``` | ||
|
|
||
| ### Options inherited from parent commands | ||
|
|
||
| ``` | ||
| --config string config file (default is $HOME/.config/equinix/equinix.yaml) | ||
| --debug Enable debug logging for HTTP requests | ||
| -f, --format string Format to use for output (json or yaml) (default "json") | ||
| ``` | ||
|
|
||
| ### SEE ALSO | ||
|
|
||
| * [equinix fabricv4 agent-templates](equinix_fabricv4_agent-templates.md) - Manage agent-templates resources | ||
|
|
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,32 @@ | ||
| ## equinix fabricv4 agents | ||
|
|
||
| Manage agents resources | ||
|
|
||
| ### Synopsis | ||
|
|
||
| Commands for managing agents resources in the API | ||
|
|
||
| ### Options | ||
|
|
||
| ``` | ||
| -h, --help help for agents | ||
| ``` | ||
|
|
||
| ### Options inherited from parent commands | ||
|
|
||
| ``` | ||
| --config string config file (default is $HOME/.config/equinix/equinix.yaml) | ||
| --debug Enable debug logging for HTTP requests | ||
| -f, --format string Format to use for output (json or yaml) (default "json") | ||
| ``` | ||
|
|
||
| ### SEE ALSO | ||
|
|
||
| * [equinix fabricv4](equinix_fabricv4.md) - Manage Equinix fauricv4 resources | ||
| * [equinix fabricv4 agents create-agent](equinix_fabricv4_agents_create-agent.md) - Execute create-agent operation | ||
| * [equinix fabricv4 agents delete-agent-by-uuid](equinix_fabricv4_agents_delete-agent-by-uuid.md) - Execute delete-agent-by-uuid operation | ||
| * [equinix fabricv4 agents get-agent-activities](equinix_fabricv4_agents_get-agent-activities.md) - Execute get-agent-activities operation | ||
| * [equinix fabricv4 agents get-agent-by-uuid](equinix_fabricv4_agents_get-agent-by-uuid.md) - Execute get-agent-by-uuid operation | ||
| * [equinix fabricv4 agents get-agents](equinix_fabricv4_agents_get-agents.md) - Execute get-agents operation | ||
| * [equinix fabricv4 agents patch-agent-by-uuid](equinix_fabricv4_agents_patch-agent-by-uuid.md) - Execute patch-agent-by-uuid operation | ||
|
|
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,47 @@ | ||
| ## equinix fabricv4 agents create-agent | ||
|
|
||
| Execute create-agent operation | ||
|
|
||
| ### Synopsis | ||
|
|
||
| Execute the create-agent operation on this service. | ||
|
|
||
| Use --request flag to provide a JSON payload for the request body. | ||
| Example: --request '{"field":"value"}' | ||
|
|
||
| The command accepts parameters based on the SDK method signature. | ||
|
|
||
| ``` | ||
| equinix fabricv4 agents create-agent [flags] | ||
| ``` | ||
|
|
||
| ### Options | ||
|
|
||
| ``` | ||
| --agent-post-request-additional-properties string agent-post-request-additional-properties (JSON) | ||
| --agent-post-request-agent-template-additional-properties string agent-post-request-agent-template-additional-properties (JSON) | ||
| --agent-post-request-agent-template-uuid string agent-post-request-agent-template-uuid | ||
| --agent-post-request-configuration-additional-properties string agent-post-request-configuration-additional-properties (JSON) | ||
| --agent-post-request-configuration-prompt string agent-post-request-configuration-prompt | ||
| --agent-post-request-description string agent-post-request-description | ||
| --agent-post-request-enabled agent-post-request-enabled | ||
| --agent-post-request-name string agent-post-request-name | ||
| --agent-post-request-project-additional-properties string agent-post-request-project-additional-properties (JSON) | ||
| --agent-post-request-project-project-id string Subscriber-assigned project ID | ||
| --agent-post-request-type string agent-post-request-type | ||
| -h, --help help for create-agent | ||
| --request string JSON payload for additional optional fields not exposed as flags | ||
| ``` | ||
|
|
||
| ### Options inherited from parent commands | ||
|
|
||
| ``` | ||
| --config string config file (default is $HOME/.config/equinix/equinix.yaml) | ||
| --debug Enable debug logging for HTTP requests | ||
| -f, --format string Format to use for output (json or yaml) (default "json") | ||
| ``` | ||
|
|
||
| ### SEE ALSO | ||
|
|
||
| * [equinix fabricv4 agents](equinix_fabricv4_agents.md) - Manage agents resources | ||
|
|
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,39 @@ | ||
| ## equinix fabricv4 agents delete-agent-by-uuid | ||
|
|
||
| Execute delete-agent-by-uuid operation | ||
|
|
||
| ### Synopsis | ||
|
|
||
| Execute the delete-agent-by-uuid operation on this service. | ||
|
|
||
| Use --request flag to provide a JSON payload for the request body. | ||
| Example: --request '{"field":"value"}' | ||
|
|
||
| The command accepts parameters based on the SDK method signature. | ||
|
|
||
| ``` | ||
| equinix fabricv4 agents delete-agent-by-uuid [flags] | ||
| ``` | ||
|
|
||
| ### Options | ||
|
|
||
| ``` | ||
| -h, --help help for delete-agent-by-uuid | ||
| --limit int limit field | ||
| --offset int offset field | ||
| --request string JSON payload for additional optional fields not exposed as flags | ||
| --uuid string uuid (required) | ||
| ``` | ||
|
|
||
| ### Options inherited from parent commands | ||
|
|
||
| ``` | ||
| --config string config file (default is $HOME/.config/equinix/equinix.yaml) | ||
| --debug Enable debug logging for HTTP requests | ||
| -f, --format string Format to use for output (json or yaml) (default "json") | ||
| ``` | ||
|
|
||
| ### SEE ALSO | ||
|
|
||
| * [equinix fabricv4 agents](equinix_fabricv4_agents.md) - Manage agents resources | ||
|
|
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,39 @@ | ||
| ## equinix fabricv4 agents get-agent-activities | ||
|
|
||
| Execute get-agent-activities operation | ||
|
|
||
| ### Synopsis | ||
|
|
||
| Execute the get-agent-activities operation on this service. | ||
|
|
||
| Use --request flag to provide a JSON payload for the request body. | ||
| Example: --request '{"field":"value"}' | ||
|
|
||
| The command accepts parameters based on the SDK method signature. | ||
|
|
||
| ``` | ||
| equinix fabricv4 agents get-agent-activities [flags] | ||
| ``` | ||
|
|
||
| ### Options | ||
|
|
||
| ``` | ||
| -h, --help help for get-agent-activities | ||
| --limit int limit field | ||
| --offset int offset field | ||
| --param-1 string param-1 (required) | ||
| --request string JSON payload for additional optional fields not exposed as flags | ||
| ``` | ||
|
|
||
| ### Options inherited from parent commands | ||
|
|
||
| ``` | ||
| --config string config file (default is $HOME/.config/equinix/equinix.yaml) | ||
| --debug Enable debug logging for HTTP requests | ||
| -f, --format string Format to use for output (json or yaml) (default "json") | ||
| ``` | ||
|
|
||
| ### SEE ALSO | ||
|
|
||
| * [equinix fabricv4 agents](equinix_fabricv4_agents.md) - Manage agents resources | ||
|
|
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is
ctreatmaused in renovate?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That's from e35bd38, to enable testing of the check logic before merge.