Skip to content

Commit 9b1ee5b

Browse files
v2 release note (#82)
1 parent 28fd3e5 commit 9b1ee5b

File tree

3 files changed

+15
-11
lines changed

3 files changed

+15
-11
lines changed

README.md

+12-8
Original file line numberDiff line numberDiff line change
@@ -14,49 +14,53 @@
1414

1515
This action makes the `protoc` compiler available to Workflows.
1616

17+
## Upgrade to v2
18+
19+
Added support **only** for the new protobuf tag naming convetion `MINOR.PATCH`.
20+
1721
## Usage
1822

1923
To get the latest stable version of `protoc` just add this step:
2024

2125
```yaml
2226
- name: Install Protoc
23-
uses: arduino/setup-protoc@v1
27+
uses: arduino/setup-protoc@v2
2428
```
2529
2630
If you want to pin a major or minor version you can use the `.x` wildcard:
2731

2832
```yaml
2933
- name: Install Protoc
30-
uses: arduino/setup-protoc@v1
34+
uses: arduino/setup-protoc@v2
3135
with:
32-
version: "3.x"
36+
version: "23.x"
3337
```
3438

3539
You can also require to include releases marked as `pre-release` in Github using the `include-pre-releases` flag (the dafault value for this flag is `false`)
3640

3741
```yaml
3842
- name: Install Protoc
39-
uses: arduino/setup-protoc@v1
43+
uses: arduino/setup-protoc@v2
4044
with:
41-
version: "3.x"
45+
version: "23.x"
4246
include-pre-releases: true
4347
```
4448

4549
To pin the exact version:
4650

4751
```yaml
4852
- name: Install Protoc
49-
uses: arduino/setup-protoc@v1
53+
uses: arduino/setup-protoc@v2
5054
with:
51-
version: "3.9.1"
55+
version: "23.2"
5256
```
5357

5458
The action queries the GitHub API to fetch releases data, to avoid rate limiting,
5559
pass the default token with the `repo-token` variable:
5660

5761
```yaml
5862
- name: Install Protoc
59-
uses: arduino/setup-protoc@v1
63+
uses: arduino/setup-protoc@v2
6064
with:
6165
repo-token: ${{ secrets.GITHUB_TOKEN }}
6266
```

package-lock.json

+2-2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "setup-protoc-action",
3-
"version": "1.2.0",
3+
"version": "2.0.0",
44
"private": true,
55
"description": "Setup protoc action",
66
"main": "lib/main.js",

0 commit comments

Comments
 (0)