ci: add reo and update build docs workflow#2703
Conversation
|
Caution Review failedPull request was closed or merged during review 📝 WalkthroughWalkthroughUpdated GitHub workflows: nightly workflow adds env vars, target-branch guard, and newer actions; docs build workflow upgrades actions, switches permissions for OIDC, adds JDK17 and Cosign signing for Helm charts; documentation template now shows an "outdated" notice linking to the latest version. Changes
Sequence Diagram(s)sequenceDiagram
participant Runner as GitHub Actions Runner
participant Checkout as Repo Checkout
participant Build as Docs Build (JDK/Python/Poetry)
participant Helm as Helm Packaging
participant Cosign as Cosign (OIDC)
participant Sigstore as Sigstore Registry
participant Git as GitHub Repo
rect rgba(100,150,240,0.5)
Runner->>Checkout: checkout repo
Checkout->>Build: set up JDK17, Python, build docs
end
rect rgba(120,200,100,0.5)
Build->>Helm: package charts (gluu-*.tgz)
Helm->>Cosign: sign-blob (uses id-token/OIDC)
Cosign->>Sigstore: upload signature metadata (.sigstore.json)
end
rect rgba(200,120,180,0.5)
Cosign->>Runner: emit .sigstore.json artifacts
Runner->>Git: add/commit/push charts + .sigstore.json (create PR/release)
Git-->>Runner: push result / PR created
end
Estimated code review effort🎯 4 (Complex) | ⏱️ ~50 minutes Possibly related PRs
Suggested labels
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
📝 Coding Plan
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
mo-auto
added
the
area-CI
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In @.github/workflows/activate-nightly-build.yml:
- Line 32: The if condition contains a reference to an undeclared input
`github.event.inputs.nightly` (in the line starting with "if: github.event_name
== 'schedule' || github.event.inputs.nightly == 'true' || github.event_name ==
'workflow_dispatch'"); remove the `github.event.inputs.nightly == 'true'` clause
from that condition (or alternatively declare `nightly` under
`workflow_dispatch.inputs`) so the condition only uses valid inputs (e.g., "if:
github.event_name == 'schedule' || github.event_name == 'workflow_dispatch'").
In @.github/workflows/build-docs.yml:
- Around line 208-210: The mv command uses the wrong glob name: replace the
incorrect janssen-*.tgz.sigstore.json with gluu-*.tgz.sigstore.json so the
produced artifact matches the move; update the line with mv ../gluu-*.tgz
../gluu-*.tgz.sigstore.json ./charts/ (and keep the subsequent git add
gluu-*.tgz gluu-*.tgz.sigstore.json && git update-index --refresh) to ensure the
files are moved and staged correctly.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro
Run ID: cc285e8e-0da9-4a6e-8701-d3a41ad6ca98
📒 Files selected for processing (3)
.github/workflows/activate-nightly-build.yml.github/workflows/build-docs.ymldocs/overrides/main.html
There was a problem hiding this comment.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
.github/workflows/build-docs.yml (1)
218-226:⚠️ Potential issue | 🟠 MajorThe stable build uses
replace-janssen-versionbut leavesreplace-flex-versiontokens unreplaced in 14+ documentation files.The nightly build properly replaces flex-related version tokens (
replace-flex-version-stableandreplace-flex-version), which appear across 14 documentation files. However, the stable build (line 224) only replacesreplace-janssen-version, which exists in just 2 files (getting-started-rancher.md and faq.md). This means the stable build leaves unreplaced version placeholders in the majority of the documentation, resulting in broken docs. Either the stable build should also replace flex tokens, or the flex tokens should be removed from stable documentation.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In @.github/workflows/build-docs.yml around lines 218 - 226, The stable branch in the workflow's LATEST handling only runs the replace for "replace-janssen-version" leaving flex tokens unreplaced; update the stable path inside the if/else block that checks LATEST to also run replacements for "replace-flex-version-stable" and "replace-flex-version" (the same sed/egrep invocations used in the nightly branch) or remove those tokens from stable docs; modify the code around the LATEST conditional so both branches handle the flex tokens consistently, referencing the LATEST variable and the tokens replace-flex-version-stable, replace-flex-version and replace-janssen-version.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In @.github/workflows/build-docs.yml:
- Around line 56-61: Remove the unused Java setup step from the workflow: delete
the job step titled "Set up JDK 17" that uses
actions/setup-java@be666c2fcd27ec809703dec50e508c2fdc7f6654 along with its
inputs (java-version: '17', distribution: 'adopt', cache: maven); ensure any
surrounding indentation and step ordering remain valid so the remaining
Python/Helm/mkdocs steps (and the generated-cn-docs.sh invocation) still run
correctly.
---
Outside diff comments:
In @.github/workflows/build-docs.yml:
- Around line 218-226: The stable branch in the workflow's LATEST handling only
runs the replace for "replace-janssen-version" leaving flex tokens unreplaced;
update the stable path inside the if/else block that checks LATEST to also run
replacements for "replace-flex-version-stable" and "replace-flex-version" (the
same sed/egrep invocations used in the nightly branch) or remove those tokens
from stable docs; modify the code around the LATEST conditional so both branches
handle the flex tokens consistently, referencing the LATEST variable and the
tokens replace-flex-version-stable, replace-flex-version and
replace-janssen-version.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro
Run ID: 8ff36cf8-871a-413d-804b-9d1b3e8733e9
📒 Files selected for processing (2)
.github/workflows/activate-nightly-build.yml.github/workflows/build-docs.yml
|
2 participants
Summary by CodeRabbit
New Features
Chores