Skip to content

Commit 2b99671

Browse files
authored
Use v1 ref in examples
The v1 branch will be updated on every release that increments the minor or patch version. Therefore, the use of this ref in workflows will result in the workflow automatically benefiting from ongoing improvements or fixes that don't cause a breaking change. The use of the @master ref should not be encouraged, as it results in the use of unstable versions of the action.
1 parent 7ad700d commit 2b99671

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

README.md

+10-5
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,14 @@ To get the latest stable version of `protoc` just add this step:
1010

1111
```yaml
1212
- name: Install Protoc
13-
uses: arduino/setup-protoc@master
13+
uses: arduino/setup-protoc@v1
1414
```
1515
1616
If you want to pin a major or minor version you can use the `.x` wildcard:
1717

1818
```yaml
1919
- name: Install Protoc
20-
uses: arduino/setup-protoc@master
20+
uses: arduino/setup-protoc@v1
2121
with:
2222
version: '3.x'
2323
```
@@ -26,7 +26,7 @@ You can also require to include releases marked as `pre-release` in Github using
2626

2727
```yaml
2828
- name: Install Protoc
29-
uses: arduino/setup-protoc@master
29+
uses: arduino/setup-protoc@v1
3030
with:
3131
version: '3.x'
3232
include-pre-releases: true
@@ -36,7 +36,7 @@ To pin the exact version:
3636

3737
```yaml
3838
- name: Install Protoc
39-
uses: arduino/setup-protoc@master
39+
uses: arduino/setup-protoc@v1
4040
with:
4141
version: '3.9.1'
4242
```
@@ -46,7 +46,7 @@ pass the default token with the `repo-token` variable:
4646

4747
```yaml
4848
- name: Install Protoc
49-
uses: arduino/setup-protoc@master
49+
uses: arduino/setup-protoc@v1
5050
with:
5151
repo-token: ${{ secrets.GITHUB_TOKEN }}
5252
```
@@ -86,4 +86,9 @@ Action the workflow should be the following:
8686
1. `rm -rf node_modules` to remove all the dependencies.
8787
1. `npm install --production` to add back **only** the runtime dependencies.
8888
1. `git add lib node_modules` to check in the code that matters.
89+
1. If the release will increment the major version, update the action refs in the examples in README.md
90+
(e.g., `uses: arduino/setup-protoc@v1` -> `uses: arduino/setup-protoc@v2`).
8991
1. open a PR and request a review.
92+
1. After PR is merged, create a release, following the `vX.X.X` tag name convention.
93+
1. After the release, rebase the release branch for that major version (e.g., `v1` branch for the v1.x.x tags) on the tag.
94+
If no branch exists for the release's major version, create one.

0 commit comments

Comments
 (0)