Skip to content

feat(renovate): enables renovate terraform manager #18

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 9, 2025

Conversation

gberenice
Copy link
Member

@gberenice gberenice commented Apr 9, 2025

what

  • Update Renovate configuration to extend from config:best-practices and the external preset github>aquaproj/aqua-renovate-config.
  • Set the schedule to run dependency updates every month.
  • Enable automatic PR labeling with auto-upgrade.
  • Configure PR assignments to be derived from CODEOWNERS.
  • Enable automatic closing of the dependency dashboard when no actionable updates remain.

why

  • Scheduling updates monthly keeps the update process streamlined.

references

Summary by CodeRabbit

  • Chores
    • Enhanced automated dependency management with monthly update scheduling.
    • Implemented automation to assign issues based on ownership and auto-close stale issues.
    • Added functionality for labeling automatic upgrade requests and refining update rules for Terraform.

@gberenice gberenice requested a review from a team as a code owner April 9, 2025 17:07
Copy link

coderabbitai bot commented Apr 9, 2025

Walkthrough

A new Renovate configuration file (.github/renovate.json5) has been added. This file sets up dependency management according to best practices and a specific Aqua Renovate configuration. It schedules updates monthly, enables automatic issue assignment based on code owners, auto-closes stale dependency issues, and applies labels for auto-upgrade pull requests. The configuration further enables the Terraform manager with exclusions for specified paths and defines package rules for optional dependencies.

Changes

File Change Summary
.github/renovate.json5 New Renovate configuration file for dependency management: schedules monthly updates, auto-assigns issues, auto-closes stale issues, labels PRs, enables Terraform manager with path exclusions, and adds package rules for optional dependencies.

Possibly related PRs

Suggested reviewers

  • Gowiem

Poem

In the code repository's quiet night,
A new config brings a guiding light.
Dependencies dance on a monthly tune,
Issues auto-assigned under a code owner's moon.
Terraform paths are watched with care,
And stale issues vanish into thin air!
Happy updates and smooth code everywhere!


📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 939b93b and b51bbdd.

📒 Files selected for processing (1)
  • .github/renovate.json5 (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • .github/renovate.json5

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

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.

Actionable comments posted: 0

🧹 Nitpick comments (1)
.github/renovate.json5 (1)

17-21: Terraform Ignore Paths Configuration.

The "terraform" block includes an "ignorePaths" setting to skip updates for files matching "**/context.tf". The inline comment clarifies that this is a mixin file. Please double-check that the ignore pattern precisely targets the intended file, avoiding any unintentional exclusions.

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5d8de5f and 939b93b.

📒 Files selected for processing (1)
  • .github/renovate.json5 (1 hunks)
🔇 Additional comments (6)
.github/renovate.json5 (6)

1-5: Extend Configuration Settings.

The configuration extends both "config:best-practices" and an external preset "github>aquaproj/aqua-renovate-config#2.7.5". This approach leverages established standards while incorporating community-driven best practices. Please ensure that the referenced external version remains up-to-date as new versions are released.


6-8: Monthly Update Schedule.

The "schedule": ["every month"] setting clearly defines a monthly update cycle. Verify that this cadence aligns with your team's operational practices and update policies.


9-10: Automatic Assignment and Dashboard Management.

Enabling "assigneesFromCodeOwners": true ensures pull requests are directed to the appropriate reviewers based on the CODEOWNERS file. Additionally, "dependencyDashboardAutoclose": true helps keep the dependency dashboard clean by auto-closing stale issues. Both settings streamline maintenance tasks effectively.


11-13: PR Labeling Strategy.

The configuration adds an "auto-upgrade" label to pull requests, which improves visibility and categorization of dependency updates. This label facilitates better triaging and review of upgrade PRs.


14-16: Terraform Manager Activation.

By listing "terraform" under "enabledManagers", the configuration ensures that Terraform dependencies are specifically targeted for updates. This is particularly useful if the project predominantly uses Terraform.


22-28: Package Rules for Optional Dependencies.

Defining a package rule that matches "optionalDependencies" is a thoughtful way to handle non-essential dependencies separately. This improves update granularity and control for optional packages. If future requirements arise, consider extending this rule with further constraints.

"github>aquaproj/aqua-renovate-config#2.7.5"
],
"schedule": [
"every month"
Copy link
Member

Choose a reason for hiding this comment

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

Do we want to set this so it's on the 1st of the month so we get them as the same time as our other monthly PR waves?

Copy link
Member Author

Choose a reason for hiding this comment

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

Sounds reasonable. Updated!

@Gowiem
Copy link
Member

Gowiem commented Apr 9, 2025

@gberenice just updated this one and put it on your plate since this is something you're actively tackling: https://www.notion.so/masterpoint/Investigate-renovate-aqua-atmos-plugin-for-easy-tofu-upgrades-8267e0592e4b497d8d0d996e29f8b760?pvs=4

Copy link
Member

@Gowiem Gowiem left a comment

Choose a reason for hiding this comment

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

:shipit:

@gberenice gberenice merged commit e45f5ac into main Apr 9, 2025
2 checks passed
@gberenice gberenice deleted the feature/renovate-config branch April 9, 2025 17:33
gberenice pushed a commit that referenced this pull request Apr 10, 2025
🤖 I have created a release *beep* *boop*
---


##
[0.3.0](v0.2.0...v0.3.0)
(2025-04-10)


### Features

* actualize README template
([#15](#15))
([5d8de5f](5d8de5f))
* **renovate:** enables renovate terraform manager
([#18](#18))
([e45f5ac](e45f5ac))


### Bug Fixes

* **renovate:** schedule update
([#20](#20))
([62d7e24](62d7e24))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
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.

2 participants