Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commitf191944

Browse files
authored
Add major version ref instructions to release documentation
Recommended practice for GitHub Actions(https://help.github.com/en/actions/building-actions/about-actions#versioning-your-action) is to add a ref to therepository for the major version, then update that ref on each release of that major version series. This allows usersof the action to configure their workflows to use the latest version of the action that won't introduce breakingchanges. Without this ref, the only options are:- pin a fixed ref - this means either frequent maintenance of the workflow to keep it up to date, or more likely using an outdated version of the action.- reference the tip of the default branch, subjecting the workflow to an unstable version of the action which may introduce bugs or breaking changes at any momentAlthough GitHub recommends using a tag, my understanding is that it's not considered best practices to alter Git tags.For this reason, I prefer using branch instead of a tag. There is no difference between the two as far as the usage ofthe action in a GitHub Workflow is concerned. The commits would be pushed to the branch on every release.I see GitHub even took the branch approach in one of the official actions:https://github.com/octokit/request-actionAnother prominent action using this approach:https://github.com/ruby/setup-rubyAnd our own actions:-https://github.com/arduino/setup-protoc-https://github.com/arduino/arduino-lint-action-https://github.com/arduino/compile-sketches-https://github.com/arduino/report-size-deltas-https://github.com/arduino/create-changelog-https://github.com/arduino/cpp-test-action
1 parent2820737 commitf191944

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

‎README.md‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,13 @@ See the [official Github documentation][pat-docs] to know more about Personal Ac
5959
3. `npm run test` to see everything works as expected.
6060
4. `npm run pack` to package for distribution
6161
5. `git add src dist` to check in the code that matters.
62-
6. open a PR and request a review.
62+
6. If the release will increment the major version, update the action refs in the examples in README.md
63+
(e.g., `uses:arduino/setup-arduino-cli@v1` -> `uses: arduino/setup-arduino-cli@v2`).
64+
7. open a PR and request a review.
65+
8. After PR is merged, create a release, following the `vX.Y.Z` tag name convention.
66+
9. After the release, rebase the release branch for that major version (e.g., `v1` branch for the v1.x.x tags) on the
67+
tag. If no branch exists for the release's major version, create one.
68+
6369

6470
[pat-docs]:https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token
6571
[example]:https://github.com/arduino/arduino-cli-example/blob/master/.github/workflows/test.yaml

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp