Skip to content
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

feat(github-actions): support ratchet comments #27846

Merged
merged 8 commits into from Mar 12, 2024

Conversation

art-shutter
Copy link
Contributor

Changes

This adds support for comments format used by ratchet tool.

Context

The ratchet tool is a locally run tool that helps update github workflows dependencies locally. This is especially useful in monorepos containing several separately-versioned github actions / workflows. As a ratchet user I would like to keep the functionality ratchet is offering me and combine it with renovate. This PR makes sure the desired pin is extracted from ratchet comments and that ratchet comments don't get deleted by renovate, including the ratchet:exclude comments.

Documentation (please check one with an [x])

  • I have updated the documentation, or
  • No documentation update is required

How I've tested my work (please select one)

I have verified these changes via:

  • Code inspection only, or
  • Newly added/modified unit tests, or
  • No unit tests but ran on a real repository, or
  • Both unit tests + ran on a real repository

Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
Copy link
Collaborator

@HonkingGoose HonkingGoose left a comment

Choose a reason for hiding this comment

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

I'm happy with the docs, I'll let the maintainers do the code review.

@viceice viceice enabled auto-merge March 11, 2024 17:59
@viceice viceice disabled auto-merge March 11, 2024 17:59
@viceice viceice changed the title feat: support ratchet comments in github-actions manager feat(github-actions): support ratchet comments Mar 11, 2024
@viceice viceice enabled auto-merge March 11, 2024 18:00
Copy link
Collaborator

@HonkingGoose HonkingGoose left a comment

Choose a reason for hiding this comment

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

Maybe we should let @TWiStErRob review the regex too.

lib/modules/manager/github-actions/extract.ts Show resolved Hide resolved
@viceice viceice added this pull request to the merge queue Mar 12, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Mar 12, 2024
@rarkins rarkins enabled auto-merge March 12, 2024 11:01
@rarkins rarkins added this pull request to the merge queue Mar 12, 2024
Merged via the queue into renovatebot:main with commit 3b4b7f1 Mar 12, 2024
35 checks passed
@renovate-release
Copy link
Collaborator

🎉 This PR is included in version 37.239.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

This means that Renovate will:

- update the version of a _pinned_ Ratchet version if needed
- not delete Ratchet comments after parsing them
Copy link

Choose a reason for hiding this comment

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

This is not true.
image
The result is still "good" as its valid but the documentation or the code should be updated.

Copy link
Collaborator

Choose a reason for hiding this comment

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

@art-shutter and @rarkins can you check this review comment?

Copy link
Member

Choose a reason for hiding this comment

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

@mkurde please open a new discussion and reference this pr

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Apr 15, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

7 participants