docs: add setup-kosli-cli GitHub Action reference page#305
Merged
Conversation
Contributor
|
Claude finished @mbevc1's task in 3m 37s —— View job Doc review for PR #305
Findings
What looks good
SummarySolid addition. One actionable improvement (missing |
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
![claude[bot]](https://avatars.githubusercontent.com/in/1236702?s=60&v=4){kind=small}
Contributor
|
I wonder if we should add it to the reference section? |
Contributor
Author
@mbevc1, yes. Just saw it. move in progress |
mbevc1
approved these changes
Jul 3, 2026
Add .mintlify/workflows/update-github-action-reference.md to keep integrations/github_action.md in sync with setup-cli-action releases. Add kosli-dev/setup-cli-action to the update-changelog workflow with its own instructions to surface only user-facing changes.
Co-authored-by: claude[bot] <209825114+claude[bot]@users.noreply.github.com>
Move the page from integrations/github_action.md to github-action-reference/setup_cli_action.md and add it as a Reference-tab item ordered after API Reference. Update cross-links and the update workflow to the new path.
Define IMAGE_NAME in the example job env and tag the build step so the kosli attest artifact command has a real image reference. Drop the redundant second link to the reference page in the CI/CD page.
mbevc1
force-pushed
the
docs/setup-cli-action-reference
branch
from
675958f to
ea40afa
Compare
| KOSLI_TRAIL: ${{ github.sha }} | ||
| IMAGE_NAME: my-registry/my-image:latest | ||
| steps: | ||
| - name: Build and push Docker image |
Contributor
There was a problem hiding this comment.
Improvement: Missing actions/checkout step. Without it, docker/build-push-action has no build context and the job will fail. Consider:
Suggested change
| - name: Build and push Docker image | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Build and push Docker image |
| To use Kosli in [Github Actions](https://docs.github.com/en/actions) workflows, you can use the kosli [CLI setup action](https://github.com/marketplace/actions/setup-kosli-cli) to install the CLI on your Github Actions Runner. | ||
| Then, you can use all the [CLI commands](/client_reference) in your workflows. | ||
| To use Kosli in [Github Actions](https://docs.github.com/en/actions) workflows, you can use the [`setup-kosli-cli` GitHub Action](/github-action-reference/setup_cli_action) to install the CLI on your Github Actions Runner. | ||
| Then, you can use all the [CLI commands](/client_reference) in your workflows. See the GitHub Action reference for its inputs, outputs, and version-pinning options. |
Contributor
There was a problem hiding this comment.
Suggestion: The second sentence links to the same page already linked in the first sentence. Consider trimming since users will see the inputs/outputs/version-pinning when they follow the first link:
Suggested change
| Then, you can use all the [CLI commands](/client_reference) in your workflows. See the GitHub Action reference for its inputs, outputs, and version-pinning options. | |
| To use Kosli in [Github Actions](https://docs.github.com/en/actions) workflows, you can use the [`setup-kosli-cli` GitHub Action](/github-action-reference/setup_cli_action) to install the CLI on your Github Actions Runner. | |
| Then, you can use all the [CLI commands](/client_reference) in your workflows. |
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.
Summary
Adds a dedicated reference page for the
kosli-dev/setup-cli-actionGitHub Action, places it in the Reference section of the site, renames the confusingly-named Actions page, and wires up automation to keep everything current.Closes #304
Changes
github-action-reference/setup_cli_action.md(title "GitHub Action") — documents the action's purpose, supported runners, inputs (version,github-token), outputs (version), version-selection rules (incl. the YAML quoting caveat), an example job, and cross-links.config/navigation.json, ordered: CLI → API → GitHub Action → Terraform → Helm → Template → Policy.integrations/actions.md→integrations/kosli_actions.mdto disambiguate the Kosli "Actions" (if-this-then-that automations) page from the GitHub Action. Fixed its internal self-link and added a redirect/integrations/actions→/integrations/kosli_actions.integrations/ci_cd.md(GitHub tab) points to the new reference page.tutorials/attest_snyk.md— fixed a mislabeled "GitHub Actions integration" link that pointed at the Kosli Actions page; now points to the new GitHub Action reference.tutorials/unauthorized_iac_changes.md— updated the "Kosli Actions" link to the renamed path.Keeping it up to date
.mintlify/workflows/update-github-action-reference.md— weekly cron watchingkosli-dev/setup-cli-action, updates the reference page when the action's inputs/outputs/behavior/runners/usage change, and skips Dependabot/chore-only releases.update-changelog.mdnow also coverskosli-dev/setup-cli-action(tag["GitHub Action"]), with its own instructions to surface only user-facing changes and consolidate accumulated dependency-bump releases.Notes
mint broken-linkscurrently aborts on a pre-existing syntax error in the generated fileclient_reference/kosli_list_controls.md(unrelated to this PR). All links introduced here were verified manually against existing files.