chore: sync with template #37
Conversation
WalkthroughThis set of changes updates several configuration and workflow files. The Renovate configuration is enhanced to support both GitHub Actions and Terraform dependencies, introducing more granular grouping and dynamic labeling for updates. The Trunk CLI and several linter plugins are updated to newer versions in the Trunk configuration. The test workflow is simplified by consolidating multiple setup and conditional steps into a single composite action, while the trunk-upgrade workflow now includes an automatic PR merge step following upgrades. Minor formatting improvements are made to workflow comments, and a single item is removed from the README acknowledgments. Possibly related PRs
Suggested reviewers
Tip ⚡️ Faster reviews with caching
Enjoy the performance boost—your workflow just got faster. 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. 🪧 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
Documentation and Community
|
![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
🧹 Nitpick comments (1)
.github/workflows/trunk-upgrade.yaml (1)
30-30: Ensure unique step IDs to avoid confusion
You've addedid: trunk-upgradeto the Upgrade step, which is great for capturing outputs. However, it duplicates the job’s owntrunk-upgradeidentifier. This can be confusing when reading logs or referencing steps. Consider renaming the step ID to something likeupgrade-steportrunk-upgrade-stepto keep names distinct.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (6)
.github/renovate.json5(2 hunks).github/workflows/lint.yaml(1 hunks).github/workflows/test.yaml(1 hunks).github/workflows/trunk-upgrade.yaml(1 hunks).trunk/trunk.yaml(2 hunks)README.md(0 hunks)
💤 Files with no reviewable changes (1)
- README.md
🔇 Additional comments (7)
.trunk/trunk.yaml (1)
5-5: Version updates align with template sync objectivesThese version updates for Trunk CLI and linters are in line with the PR objective of syncing with the template repository. Note that Renovate has been updated from 39.x to 40.0.0, which is a major version change, but since this is just updating the linter version used by Trunk (not the actual Renovate configuration), no breaking changes are expected in your workflow.
Also applies to: 23-23, 26-26, 32-32
.github/workflows/lint.yaml (1)
16-16: Improved comment formatting for consistencyThese formatting improvements add a space after the hash symbol in the version comments, making them more readable and consistent with standard Markdown comment formatting. This type of consistency is valuable for maintainability.
Also applies to: 18-18
.github/renovate.json5 (4)
7-9: Enhanced dependency management by adding GitHub Actions supportAdding GitHub Actions as an enabled manager will ensure that action dependencies are automatically kept up-to-date alongside Terraform dependencies. This is a valuable improvement that complements the workflow simplifications in test.yaml.
19-24: Improved labeling with dynamic templateThe change from a fixed "auto-upgrade" label to a dynamic "{{manager}}" template will provide better categorization of PRs based on the dependency type. This makes it easier to identify and prioritize different types of dependency updates.
27-44: Well-structured automation rules for dependency updatesThese package rules implement a sophisticated approach to dependency management:
- Minor/patch/pin/digest updates for GitHub Actions will be auto-merged (low risk)
- Major updates require manual review (higher risk)
- Terraform updates are grouped and labeled appropriately
This strategy reduces maintenance overhead while ensuring that high-risk changes get proper attention.
47-62: Consistent grouping for better PR organizationAdding the explicit "groupName": "tf" to all Terraform-related package rules ensures that updates are consolidated into fewer PRs, reducing noise and making reviews more efficient. The consistent approach across different file types and dependency types improves the overall configuration quality.
.github/workflows/test.yaml (1)
24-28: Excellent workflow simplification using composite actionReplacing multiple discrete steps with a single composite action is a significant improvement that:
- Reduces workflow complexity and maintenance burden
- Follows DRY principles by encapsulating repeated logic
- Aligns with the enhanced Renovate configuration for GitHub Actions
- Makes the workflow more readable and easier to understand
This architectural improvement is a best practice for GitHub Actions workflows and perfectly aligns with the goal of syncing with template improvements.
| - name: Merge PR automatically | ||
| if: steps.trunk-upgrade.outputs.pull-request-number != '' | ||
| env: | ||
| GITHUB_TOKEN: ${{ steps.generate-token.outputs.token }} | ||
| PR_NUMBER: ${{ steps.trunk-upgrade.outputs.pull-request-number }} | ||
| run: | | ||
| gh pr merge "$PR_NUMBER" --squash --auto --delete-branch |
There was a problem hiding this comment.
Fix the if conditional syntax to guard the merge step
The if line is missing the ${{ }} expression wrapper, so it will always evaluate as a non-empty string and run the merge step even when no PR exists. Update it to:
if: ${{ steps.trunk-upgrade.outputs.pull-request-number != '' }}This ensures the merge runs only when the upgrade action actually opened a PR.
🤖 Prompt for AI Agents (early access)
In .github/workflows/trunk-upgrade.yaml around lines 37 to 43, the if
conditional for the merge step is missing the ${{ }} expression wrapper, causing
it to always evaluate as true and run the merge even when no PR exists. Fix this
by wrapping the condition in ${{ }}, changing the line to if: ${{
steps.trunk-upgrade.outputs.pull-request-number != '' }} so the merge step only
runs when a PR number is present.
gberenice
force-pushed
the
chore/sync-with-templat
branch
from
50c1e5c to
a227db0
Compare
what
why
references
Summary by CodeRabbit