Skip to content

feat(docs): add permission configuration step to external CI guide#311

Open
kaviththiranga wants to merge 1 commit intoopenchoreo:mainfrom
kaviththiranga:fix-ext-ci-docs
Open

feat(docs): add permission configuration step to external CI guide#311
kaviththiranga wants to merge 1 commit intoopenchoreo:mainfrom
kaviththiranga:fix-ext-ci-docs

Conversation

@kaviththiranga
Copy link
Contributor

@kaviththiranga kaviththiranga commented Feb 18, 2026

Add Step 2 documenting how to configure RBAC permissions for the
Jenkins service account via the Backstage Access Control UI, including
role creation with workload:create action and role binding setup.
Renumber existing steps 2-4 to 3-5 accordingly.

image

Summary by CodeRabbit

Release Notes

  • Documentation

    • Expanded External CI integration guide with new permissions configuration section covering Backstage access control
    • Added detailed Jenkins pipeline examples demonstrating API integration for workload management
    • Reorganized steps and enhanced troubleshooting guidance
  • Chores

    • Updated marketplace plugin popularity metrics

  Add Step 2 documenting how to configure RBAC permissions for the
  Jenkins service account via the Backstage Access Control UI, including
  role creation with workload:create action and role binding setup.
  Renumber existing steps 2-4 to 3-5 accordingly.

Signed-off-by: Kavith Lokuhewage <kaviththiranga@gmail.com>
@coderabbitai
Copy link

coderabbitai bot commented Feb 18, 2026

📝 Walkthrough

Walkthrough

This pull request updates the External CI documentation with a reorganized permission configuration guide, including new steps for Backstage Access Control and cluster role setup, alongside a Jenkins pipeline example. Additionally, marketplace plugin star counts are incrementally updated across multiple entries.

Changes

Cohort / File(s) Summary
Documentation Restructuring
docs/user-guide/ci/external-ci.mdx
Reorganized External CI guide with new Step 2 for permission configuration (Backstage Access Control, cluster role binding), adjusted subsequent step numbering, added detailed Jenkins pipeline example with environment variables and API calls, and expanded troubleshooting guidance.
Marketplace Plugin Data
src/data/marketplace-plugins.json
Updated GitHub star counts across 13 plugin entries with minor increments (most +1 to +6 stars, one -1 star); no structural or behavioral changes.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Suggested reviewers

  • nilushancosta
  • chathuranga95
  • LakshanSS

Poem

🐰 The docs now dance with clearer steps,
Permissions configured, control is kept,
Plugin stars twinkle bright and true,
A little guide refresh makes all things new!

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Description check ❓ Inconclusive The description explains the purpose (adding Step 2 for RBAC permissions) and includes a screenshot, but omits required checklist items from the template. Complete the checklist from the template: confirm whether sidebars.ts was updated, document local preview verification, build verification, and link validation steps.
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the main change: adding a permission configuration step to the external CI guide. It accurately reflects the primary purpose of the PR.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
docs/user-guide/ci/external-ci.mdx (1)

49-52: ⚠️ Potential issue | 🟠 Major

Remove explicit default credentials from docs.

Publishing real default credentials is a compliance risk. Replace with placeholders and direct readers to configure secrets securely.

Proposed fix
-2. Log in with your admin credentials (default: `admin` / `admin`)
+2. Log in with your admin credentials (e.g., `THUNDER_ADMIN_USERNAME` / `THUNDER_ADMIN_PASSWORD`)

Based on learnings: Do not document or expose real credentials in docs or sample files; replace with placeholders and explain secure configuration.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/user-guide/ci/external-ci.mdx` around lines 49 - 52, Remove the explicit
default credentials "admin / admin" from the step that instructs logging in;
replace them with a placeholder (e.g., <ADMIN_USERNAME> / <ADMIN_PASSWORD> or
"your-admin-username" / "your-admin-password") and add a short note instructing
readers to configure and store those secrets securely (e.g., use secret
management or CI credentials store) when creating the Admin account and adding
Jenkins credentials; update the line that currently contains the literal
credentials to the placeholder text and add one brief sentence about secure
storage.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Outside diff comments:
In `@docs/user-guide/ci/external-ci.mdx`:
- Around line 49-52: Remove the explicit default credentials "admin / admin"
from the step that instructs logging in; replace them with a placeholder (e.g.,
<ADMIN_USERNAME> / <ADMIN_PASSWORD> or "your-admin-username" /
"your-admin-password") and add a short note instructing readers to configure and
store those secrets securely (e.g., use secret management or CI credentials
store) when creating the Admin account and adding Jenkins credentials; update
the line that currently contains the literal credentials to the placeholder text
and add one brief sentence about secure storage.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant