Skip to content

Update links and README.md#81601

Open
psalajova wants to merge 1 commit into
openshift:mainfrom
psalajova:post-migration-doc-update
Open

Update links and README.md#81601
psalajova wants to merge 1 commit into
openshift:mainfrom
psalajova:post-migration-doc-update

Conversation

@psalajova

@psalajova psalajova commented Jul 8, 2026

Copy link
Copy Markdown
Contributor

Similar to openshift/ci-docs#600, this PR contains the changes to the docs that will take effect once the secret migration is done.

/hold

Summary by CodeRabbit

Updated the CI secret bootstrap documentation to better explain how secret definitions are managed during the GSM migration. In practical terms, this clarifies for OpenShift CI contributors that the legacy Vault-based _config.yaml is being phased out, while gsm-config.yaml is now the source of truth for GSM-backed secret bundles and mappings. The README also now points contributors to the correct “Adding a New Secret to CI” guide, and the GSM config comment links directly to the relevant documentation instead of a placeholder.

@openshift-ci openshift-ci Bot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jul 8, 2026
@coderabbitai

coderabbitai Bot commented Jul 8, 2026

Copy link
Copy Markdown
Contributor

Walkthrough

This PR updates documentation for the ci-secret-bootstrap tool: the README now describes two configuration files (legacy _config.yaml and GSM-based gsm-config.yaml) and links to a user guide, while gsm-config.yaml's header comment replaces a TODO with an actual docs URL.

Changes

Documentation updates

Layer / File(s) Summary
README and config comment updates
core-services/ci-secret-bootstrap/README.md, core-services/ci-secret-bootstrap/gsm-config.yaml
README rewritten to enumerate _config.yaml (legacy, being phased out) and gsm-config.yaml (GSM-based), with a link to "Adding a New Secret to CI"; gsm-config.yaml header comment updated with an actual docs link replacing a TODO placeholder.

Estimated code review effort: 1 (Trivial) | ~2 minutes

🚥 Pre-merge checks | ✅ 15
✅ Passed checks (15 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title matches the documentation-focused changes by mentioning links and README updates.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Stable And Deterministic Test Names ✅ Passed Only README.md and gsm-config.yaml docs changed; no Ginkgo test titles were added or modified.
Test Structure And Quality ✅ Passed No Ginkgo test code was changed; the PR only updates README and YAML docs, so the test-structure check is not applicable.
Microshift Test Compatibility ✅ Passed No Ginkgo tests were added or modified; only README and YAML docs changed, so MicroShift compatibility is not applicable.
Single Node Openshift (Sno) Test Compatibility ✅ Passed Only docs files changed; no Ginkgo e2e tests were added, so SNO compatibility review is not applicable.
Topology-Aware Scheduling Compatibility ✅ Passed Docs-only changes to README and a YAML comment; no deployment manifests, controllers, or scheduling logic were added or modified.
Ote Binary Stdout Contract ✅ Passed PR only changes README and a YAML comment; no process-level code, entrypoints, or stdout writes were touched.
Ipv6 And Disconnected Network Test Compatibility ✅ Passed Only README and YAML doc/comment changes were made; no new Ginkgo/e2e tests or network-dependent code were added.
No-Weak-Crypto ✅ Passed Only README and YAML comment updates were changed; no weak crypto, custom crypto, or secret comparisons were added.
Container-Privileges ✅ Passed Only README and a config comment changed; no privileged K8s/container settings were present in the touched files.
No-Sensitive-Data-In-Logs ✅ Passed The PR only changes docs/comments; no new log statements or sensitive values were introduced in the touched files.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

@openshift-merge-bot openshift-merge-bot Bot added the rehearsals-ack Signifies that rehearsal jobs have been acknowledged label Jul 8, 2026
@openshift-merge-bot

Copy link
Copy Markdown
Contributor

[REHEARSALNOTIFIER]
@psalajova: no rehearsable tests are affected by this change

Note: If this PR includes changes to step registry files (ci-operator/step-registry/) and you expected jobs to be found, try rebasing your PR onto the base branch. This helps pj-rehearse accurately detect changes when the base branch has moved forward.

@openshift-ci openshift-ci Bot requested review from pruan-rht and smg247 July 8, 2026 10:27
@openshift-ci

openshift-ci Bot commented Jul 8, 2026

Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: psalajova

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@openshift-ci openshift-ci Bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jul 8, 2026

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@core-services/ci-secret-bootstrap/README.md`:
- Around line 5-11: The directory overview in README.md is misleading because it
lists only the secret-definition files while omitting gsm-project-config.yaml,
which is also used by ci-secret-bootstrap. Update the intro text to separate the
secret-definition/config files from the project config, and make sure the
inventory explicitly includes gsm-project-config.yaml alongside _config.yaml and
gsm-config.yaml so the README matches how the validation script uses these
files.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository YAML (base), Central YAML (inherited)

Review profile: CHILL

Plan: Enterprise

Run ID: 3622d79f-c2e4-4990-a6fa-cda695fcdee5

📥 Commits

Reviewing files that changed from the base of the PR and between 821027b and a92d99e.

📒 Files selected for processing (2)
  • core-services/ci-secret-bootstrap/README.md
  • core-services/ci-secret-bootstrap/gsm-config.yaml

Comment thread core-services/ci-secret-bootstrap/README.md
@openshift-ci

openshift-ci Bot commented Jul 8, 2026

Copy link
Copy Markdown
Contributor

@psalajova: all tests passed!

Full PR test history. Your PR dashboard.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

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

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. rehearsals-ack Signifies that rehearsal jobs have been acknowledged

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant