Reconciled Renovate variables + docs. #1705
Conversation
WalkthroughThis update refactors Renovate integration in CI/CD workflows and documentation. It replaces hardcoded aliases with environment variables for configuration in CircleCI, adds explicit checks for required variables, clarifies environment variable requirements in GitHub Actions, expands documentation, and updates spell-check configuration to recognize "yourorg". Changes
Sequence Diagram(s)sequenceDiagram
participant CircleCI
participant RenovateJob
participant EnvVars
participant Renovate
CircleCI->>RenovateJob: Start deps-updates job
RenovateJob->>EnvVars: Check RENOVATE_TOKEN, RENOVATE_REPOSITORIES, RENOVATE_GIT_AUTHOR
EnvVars-->>RenovateJob: Return values / missing status
alt Any variable missing
RenovateJob-->>CircleCI: Halt job with error message
else All variables present
RenovateJob->>Renovate: Validate configuration
RenovateJob->>Renovate: Run Renovate
end
Possibly related PRs
Poem
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
⛔ Files ignored due to path filters (6)
.vortex/installer/tests/Fixtures/install/_baseline/.github/workflows/deps-updates.ymlis excluded by!.vortex/installer/tests/Fixtures/**.vortex/installer/tests/Fixtures/install/ciprovider_circleci/.circleci/config.ymlis excluded by!.vortex/installer/tests/Fixtures/**.vortex/installer/tests/Fixtures/install/deploy_type_all_circleci/.circleci/config.ymlis excluded by!.vortex/installer/tests/Fixtures/**.vortex/installer/tests/Fixtures/install/deploy_type_none_circleci/.circleci/config.ymlis excluded by!.vortex/installer/tests/Fixtures/**.vortex/installer/tests/Fixtures/install/deps_updates_provider_ci_circleci/.circleci/config.ymlis excluded by!.vortex/installer/tests/Fixtures/**.vortex/installer/tests/Fixtures/install/names/.github/workflows/deps-updates.ymlis excluded by!.vortex/installer/tests/Fixtures/**
📒 Files selected for processing (4)
.circleci/config.yml(4 hunks).github/workflows/deps-updates.yml(3 hunks).vortex/docs/content/tools/renovate.mdx(2 hunks).vortex/docs/cspell.json(1 hunks)
🧰 Additional context used
🪛 LanguageTool
.vortex/docs/content/tools/renovate.mdx
[uncategorized] ~53-~53: Loose punctuation mark.
Context: ...aults if not set): - RENOVATE_DRY_RUN: Set to true to test runs without maki...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~83-~83: Loose punctuation mark.
Context: ... if not set): - RENOVATE_REPOSITORIES: Repository to run Renovate on in format...
(UNLIKELY_OPENING_PUNCTUATION)
⏰ Context from checks skipped due to timeout of 90000ms (6)
- GitHub Check: build (0)
- GitHub Check: build (1)
- GitHub Check: vortex-test-workflow (3)
- GitHub Check: vortex-test-workflow (0)
- GitHub Check: vortex-test-workflow (2)
- GitHub Check: vortex-test-workflow (1)
🔇 Additional comments (21)
.vortex/docs/cspell.json (1)
62-62: Approve addition of placeholder term “yourorg”.
Including “yourorg” in the dictionary will prevent false positives when referencing organization-specific placeholders in docs..github/workflows/deps-updates.yml (5)
2-2: Clarify job purpose. The added comment clearly indicates that this workflow handles self-hosted dependency updates, improving readability for maintainers.
26-26: Approve requirement check step. Introducing a dedicatedcheck-requirementsstep with a meaningful name improves clarity and aligns with the CircleCI configuration.
30-31: Approve early exit on missing token. Gracefully exiting with status 0 whenRENOVATE_TOKENis unset prevents failures and aligns with the documented skip-job behavior.
34-37: Approve git author validation. Adding an explicit check forRENOVATE_GIT_AUTHORensures all required variables are present before proceeding, matching the CircleCI logic.
54-54: Approve explicit author attribution. PassingRENOVATE_GIT_AUTHORfrom repo variables (with no fallback) ensures commit authorship is correctly enforced..vortex/docs/content/tools/renovate.mdx (9)
25-27: Approve feature list updates. Adding items for manual trigger and debug logging in the overview enhances discoverability of these capabilities.
41-47: Approve CircleCI required variables section. The documentation now clearly listsRENOVATE_TOKEN,RENOVATE_REPOSITORIES, andRENOVATE_GIT_AUTHORas mandatory, matching the CI configuration.
49-54: Approve CircleCI optional variables section. Specifying defaults forRENOVATE_DRY_RUNandRENOVATE_DEPENDENCY_DASHBOARDprovides clarity on configurable behavior.🧰 Tools
🪛 LanguageTool
[uncategorized] ~53-~53: Loose punctuation mark.
Context: ...aults if not set): -RENOVATE_DRY_RUN: Set totrueto test runs without maki...(UNLIKELY_OPENING_PUNCTUATION)
58-61: Approve CircleCI manual trigger note. Clarifying that the job can be triggered manually from the CircleCI UI aligns docs with the workflow implementation.
62-66: Approve CircleCI debug logging details. Documenting thatLOG_LEVEL: 'debug'is enabled by default helps users troubleshoot Renovate runs.
70-77: Approve GitHub Actions required variables section. Clearly calling outRENOVATE_TOKENandRENOVATE_GIT_AUTHOR(with their repository settings locations) aligns with the updated workflow.
79-85: Approve GitHub Actions optional variables section. ListingRENOVATE_REPOSITORIES,RENOVATE_DRY_RUN, andRENOVATE_DEPENDENCY_DASHBOARDwith defaults ensures consistent user expectations.🧰 Tools
🪛 LanguageTool
[uncategorized] ~83-~83: Loose punctuation mark.
Context: ... if not set): -RENOVATE_REPOSITORIES: Repository to run Renovate on in format...(UNLIKELY_OPENING_PUNCTUATION)
89-93: Approve GitHub Actions manual trigger note. Highlighting the workflow dispatch option in the Actions UI provides clear instructions for manual runs.
94-98: Approve GitHub Actions debug logging details. Specifying that settingLOG_LEVEL=debugenables detailed logs supports effective troubleshooting..circleci/config.yml (6)
370-371: Approve explicit Deploy step naming. Addingname: Deployimproves clarity in the job output and logs.
396-397: Approvedeploy-tagsstep naming. Includingname: Deployin the tag-based deployment job ensures consistency across deploy workflows.
406-410: Approve Renovate job documentation. The added comments clearly define which environment variables (RENOVATE_TOKEN,RENOVATE_REPOSITORIES,RENOVATE_GIT_AUTHOR) must be set in CircleCI.
422-439: Approve environment validation logic. The new run step gracefully halts the job if any requiredRENOVATE_*variable is missing, preventing failures and matching the GitHub Actions workflow’s behavior.
440-446: Approve Renovate execution steps. Separating validation, configuration validation, and execution into distinct run steps enhances readability and maintainability.
671-676: Approve explicit cron schedule. Replacing the alias-based schedule with the concrete cron expression ("5 11,23 * * *") ensures the timing is transparent and maintainable.
| exit 0 | ||
| fi | ||
| echo "should_run=true" >> "$GITHUB_OUTPUT" |
There was a problem hiding this comment.
🧹 Nitpick (assertive)
Suggest defaulting should_run. To avoid undefined output, consider initializing should_run=false at the top of the step and only overriding to true after both checks pass:
+ echo "should_run=false" >> "$GITHUB_OUTPUT"
if [ -z "${{ secrets.RENOVATE_TOKEN }}" ] || [ -z "${{ vars.RENOVATE_GIT_AUTHOR }}" ]; then
exit 0
fi
echo "should_run=true" >> "$GITHUB_OUTPUT"📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| echo "should_run=true" >> "$GITHUB_OUTPUT" | |
| echo "should_run=false" >> "$GITHUB_OUTPUT" | |
| if [ -z "${{ secrets.RENOVATE_TOKEN }}" ] || [ -z "${{ vars.RENOVATE_GIT_AUTHOR }}" ]; then | |
| exit 0 | |
| fi | |
| echo "should_run=true" >> "$GITHUB_OUTPUT" |
🤖 Prompt for AI Agents
In .github/workflows/deps-updates.yml at line 39, the variable should_run is set
to true without a default value, which can lead to undefined output. Initialize
should_run to false at the beginning of the step, then update it to true only if
both required conditions are met, ensuring the output is always defined.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## develop #1705 +/- ##
========================================
Coverage 70.58% 70.58%
========================================
Files 76 76
Lines 4351 4351
========================================
Hits 3071 3071
Misses 1280 1280 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Summary by CodeRabbit
Chores
Documentation