Make the automatic pack version update PRs more descriptive #161
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
We now use GitHub Actions for all of our repositories (having recently migrated from Circle CI), and for those that are CNB related and need the Pack CLI, we use the `buildpacks/github-actions/setup-pack` action. We intentionally don't set an explicit `pack-version`, to avoid having to manually update multiple repositories when a new Pack version is released. Instead, we pin to a specific version of this Action, and then enable Actions version bumping in Dependabot, which gives us PRs like: heroku/libcnb.rs#434 However, currently the release notes section of those Dependabot PRs contain entries like: ``` - Update default version of setup-pack/action.yml ``` ...which somewhat buries the lede - that: (a) the release actually changed the default version of *Pack* (and not some GitHub Actions schema version or something), and (b) what that version now is. These changelog entries come directly from the commit log, and so the wording is that from the automated bot PRs, eg: buildpacks#159 As such, I've updated the template to say more explicitly what it is changing (Pack version, not some action version), what the new version is, and for bonus points links to the release notes, so they'll handily show up when we review our own Dependabot PRs for updating this action. I don't have an easy way to test this change, so be aware that this is untested. It is based on the "echo to `GITHUB_OUTPUT`" approach I see used here: https://github.com/buildpacks/pack/blob/b10e41f40b119ff5e954d060c24e1085a8b92be6/.github/workflows/delivery-homebrew.yml#L65-L90 ...and for which the GitHub docs are here: https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#setting-an-output-parameter Signed-off-by: Ed Morley <501702+edmorley@users.noreply.github.com>
jkutner
added
type:enhancement
jkutner
approved these changes
Dec 8, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
We now use GitHub Actions for all of our repositories (having recently migrated from Circle CI) - and for those that are CNB related and need the Pack CLI, we use the
buildpacks/github-actions/setup-packaction.We intentionally don't set an explicit
pack-version, to avoid having to manually update multiple repositories when a new Pack version is released. Instead, we rely on the Action's default Pack version, pin to a specific version of this Action, and then enable GitHub Actions version bumping in Dependabot. This gives us the best of both worlds: determinism but minimal toil.Dependabot then opens PRs like:
heroku/libcnb.rs#434
However, currently the release notes section of those Dependabot PRs (which we'll look at when reviewing the PR) contain entries like:
...which somewhat buries the lede - that:
(a) the action release actually includes a changed default version of Pack (and not some GitHub Actions schema/API/release version or something), and
(b) what that version now is.
These changelog entries come directly from the commit log, and so the wording is that from the automated bot PRs, eg:
#159
As such, I've updated the template to say more explicitly:
I don't have an easy way to test this change, so be aware that this is untested.
It is based on the "echo to
GITHUB_OUTPUT" approach I see used here:https://github.com/buildpacks/pack/blob/b10e41f40b119ff5e954d060c24e1085a8b92be6/.github/workflows/delivery-homebrew.yml#L65-L90
...and for which the GitHub docs are here:
https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#setting-an-output-parameter
Signed-off-by: Ed Morley 501702+edmorley@users.noreply.github.com