Skip to content

Commit 3582a0e

Browse files
authored
Merge pull request #25 from per1234/major-version-ref-instructions
Add major version ref instructions to release documentation
2 parents 2820737 + f191944 commit 3582a0e

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)