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

chore(renovate): update GitHub Actions major versions in docs #7584

Merged

Conversation

mkniewallner
Copy link
Contributor

@mkniewallner mkniewallner commented Sep 20, 2024

Summary

Originally wanted to update the reference to astral-sh/setup-uv in https://docs.astral.sh/uv/guides/integration/github/, but thought it could be nice to automate those updates through Renovate. The custom manager will look for any major version GitHub Action reference in any Markdown file in docs directory, and raise a PR to update it.

Possible improvements:

  • We could separate those updates from updating the actions updates for uv's own GitHub Actions workflow, which would end up raising 2 different PRs instead of grouping them (example of the current behaviour without this improvement in Update actions/checkout action to v4 mkniewallner/mkv-playground#4 where we update the doc reference at the same time as a real dependency usage in a workflow).
  • Should the PRs be raised immediately, to handle the update as soon as possible, instead of waiting for the regular weekly Monday schedule? This would ensure that astral-sh/setup-uv references are handled as early as possible. done in 6af7f45

Test Plan

I've tested that with https://github.com/mkniewallner/mkv-playground/blob/00ddfb69003843ad57d05f9ef036e655aaf765d7/renovate.json5 and https://github.com/mkniewallner/mkv-playground/blob/00ddfb69003843ad57d05f9ef036e655aaf765d7/docs/integeration/foo.md, where Renovate raised 2 PRs:

@mkniewallner mkniewallner marked this pull request as ready for review September 20, 2024 12:35
@zanieb
Copy link
Member

zanieb commented Sep 20, 2024

Thank you! This is great.

I don't mind a weekly cadence.

Separate pull requests seems kind of nice? But maybe not necessary. Is it hard to do? I'm willing to wait and see if it's problematic.

@zanieb zanieb self-assigned this Sep 20, 2024
@mkniewallner
Copy link
Contributor Author

Separate pull requests seems kind of nice? But maybe not necessary. Is it hard to do? I'm willing to wait and see if it's problematic.

I don't think it's hard to do, will play with that in my test repository then update this PR (or report back if this is in the end).

@mkniewallner
Copy link
Contributor Author

Separate pull requests seems kind of nice? But maybe not necessary. Is it hard to do? I'm willing to wait and see if it's problematic.

I don't think it's hard to do, will play with that in my test repository then update this PR (or report back if this is in the end).

Played with that in mkniewallner/mkv-playground@4c3ea0d (inspired by an example from Renovate itself), and it works well:

.github/renovate.json5 Outdated Show resolved Hide resolved
@zanieb zanieb added documentation Improvements or additions to documentation releases Related to building and distributing release artifacts of uv and removed releases Related to building and distributing release artifacts of uv labels Sep 20, 2024
Co-authored-by: Zanie Blue <contact@zanie.dev>
@zanieb zanieb merged commit 2144c8b into astral-sh:main Sep 20, 2024
58 checks passed
@mkniewallner mkniewallner deleted the chore/update-github-actions-references-docs branch September 20, 2024 20:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants