docs: align CLI docs and install guidance#2684
Conversation
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #2684 +/- ##
=======================================
Coverage 58.85% 58.85%
=======================================
Files 204 204
Lines 20149 20149
=======================================
Hits 11859 11859
Misses 7525 7525
Partials 765 765 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the documentation and CLI help text for Pipelines-as-Code. Key changes include updating the Homebrew installation instructions to use the new cask name, adding documentation for the cel, completion, and version subcommands, and clarifying the behavior of the LLM analysis on_cel field. Additionally, it improves the formatting of the requirements page, adds Forgejo to the supported providers list, and updates the bash completion path for macOS. I have no feedback to provide as there were no review comments to evaluate.
|
splitted all the commits to make it easy to review, i can make a big one instead if that really useful |
|
/gemini review |
There was a problem hiding this comment.
Code Review
This pull request updates the documentation and configuration for Pipelines-as-Code, including revised installation instructions, new CLI command details, and expanded API settings such as gitops_command_prefix and custom-console-url-namespace. The feedback focuses on improving the reliability of CEL expression examples in the documentation by using the exists macro to check PipelineRun conditions instead of relying on fixed array indices, which are not guaranteed in Tekton.
|
/test linters |
🤖 AI Analysis - pr-complexity-rating📊 PR Review Complexity
Overall difficulty: [Easy] SummaryThis PR documents the Suggested reviewers focus
Generated by Pipelines-as-Code LLM Analysis |
The README showed the wrong bootstrap command for new users. Update it so the first step works as written.
The AI docs said a role would always run when no CEL condition was set. Update the wording so it matches the code and only runs on failed PipelineRuns by default.
The GitHub App bootstrap page made the command sound simpler than it really is. Rewrite it so users know what the command actually does and when it stops for an existing installation.
The CLI landing page was missing some commands that the tool already supports. Add them so the index gives a complete view of the CLI.
The completion page and the built-in help had drifted apart. Align the examples and add the missing PowerShell guidance so users see one consistent set of instructions.
The delete docs showed an example that looked runnable but was missing the repository name. Update the example so users know exactly what to type.
Forgejo support exists, but the installation overview did not mention it. Add it so the docs match the providers the project supports.
Tidy up a few rough edges in the docs, including broken list formatting and a stray typo in the LLM guide, to make the pages easier to read.
The install docs used different Homebrew commands in different places. Update the user-facing docs to use the confirmed cask command everywhere so the install path is consistent.
Created a symbolic link to point the agent configuration to the central skills directory. This ensured that the agent can properly access and utilize the defined skill set. Replaced the content of CLAUDE.md with a symbolic link to AGENTS.md to ensure consistent documentation across the project. Signed-off-by: Chmouel Boudjnah <chmouel@redhat.com>
Clarify that global extra-repository token scoping via secret-github-app-scope-extra-repos works without disabling the repository-scoped token behavior. Document the current implementation rule for settings.github_app_token_scope_repos: when used on its own, it requires secret-github-app-token-scoped to be false. Keep the namespace-matching constraint for repository-level patterns. Signed-off-by: Chmouel Boudjnah <chmouel@redhat.com>
Update the ConfigMap reference and shipped sample manifest to use the actual default Artifact Hub API endpoint. Adjust the hub wording so the docs describe API endpoints rather than website roots. This aligns the documented default with the resolver implementation and avoids broken copied configurations. Signed-off-by: Chmouel Boudjnah <chmouel@redhat.com>
Fix the prose in the comment settings guide to point to the real Repository CR path for provider comment strategy settings. The examples already use spec.settings.<provider>.comment_strategy; this commit makes the surrounding explanation match the schema so users do not copy an invalid field path from the text. Signed-off-by: Chmouel Boudjnah <chmouel@redhat.com>
Update the Forgejo provider guide to reference the actual policy fields used by the Repository CR. Replace the stale policy.team_ids mention with settings.policy.ok_to_test and settings.policy.pull_request so the documentation matches the current Forgejo and Gitea policy model. Signed-off-by: Chmouel Boudjnah <chmouel@redhat.com>
Fix the AI settings reference so its on_cel examples use the actual LLM CEL context shape exposed by Pipelines-as-Code. Replace stale examples that used bare event_type, bare status, and a nonexistent has_label helper with expressions based on body.event and body.pipelineRun. Add a short note that points readers at the structured CEL context. Signed-off-by: Chmouel Boudjnah <chmouel@redhat.com>
Add the missing custom-console-url-namespace entry to the ConfigMap reference. The setting already exists in the configuration model and is used for namespace-level custom console links. This commit makes the API reference complete alongside the other custom console URL fields. Signed-off-by: Chmouel Boudjnah <chmouel@redhat.com>
Document gitops_command_prefix in the Repository settings API reference. The field is already supported and covered in the GitOps guide, but it was missing from the settings reference that claims to describe all available fields. Add the reference entry and cross-link back to the behavior guide. Signed-off-by: Chmouel Boudjnah <chmouel@redhat.com>
Remove the Forgejo example that suggests an empty webhook secret. This setup cannot work because Forgejo/Gitea validation requires a signature and a non-empty shared secret. Align the remaining hub-url examples with the Artifact Hub API default used by the shipped ConfigMap and settings defaults. This keeps the architecture and OpenShift installation docs consistent with the main config reference. Signed-off-by: Chmouel Boudjnah <chmouel@redhat.com>
|
@chmouel do I squash commits? there are 18... |
|
@zakisk yeah i separated them, i don't think it was worth it to create 18 Pull requests, I dont think we have to squash commits when they clearly separate things.. |
4 participants
📝 Description of the Change
This PR refreshes the pac documentation so the install and usage guidance matches the current CLI behavior, while cleaning up a few related docs pages.
Highlights:
bootstrap github-appbehavior and when--force-installis neededtkn pac delete repo <repository-name>syntaxon_celbehavior for LLM analysis rolesCLAUDE.mdand.agents/skills)🔗 Linked GitHub Issue
Fixes #
🧪 Testing Strategy
🤖 AI Assistance
AI assistance can be used for various tasks, such as code generation,
documentation, or testing.
Please indicate whether you have used AI assistance
for this PR and provide details if applicable.
Important
Slop will be simply rejected, if you are using AI assistance you need to make sure you
understand the code generated and that it meets the project's standards. you
need at least know how to run the code and deploy it (if needed). See
startpaac to make it easy
to deploy and test your code changes.
If the majority of the code in this PR was generated by an AI, please add a
Co-authored-bytrailer to your commit message.For example:
Co-authored-by: Claude noreply@anthropic.com
✅ Submitter Checklist
fix:,feat:) matches the "Type of Change" I selected above.make testandmake lintlocally to check for and fix anyissues. For an efficient workflow, I have considered installing
pre-commit and running
pre-commit installtoautomate these checks.