Skip to content

Commit

Permalink
v2 release note (#82)
Browse files Browse the repository at this point in the history
  • Loading branch information
alessio-perugini authored May 31, 2023
1 parent 28fd3e5 commit 9b1ee5b
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 11 deletions.
20 changes: 12 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,49 +14,53 @@

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

## Upgrade to v2

Added support **only** for the new protobuf tag naming convetion `MINOR.PATCH`.

## Usage

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

```yaml
- name: Install Protoc
uses: arduino/setup-protoc@v1
uses: arduino/setup-protoc@v2
```
If you want to pin a major or minor version you can use the `.x` wildcard:

```yaml
- name: Install Protoc
uses: arduino/setup-protoc@v1
uses: arduino/setup-protoc@v2
with:
version: "3.x"
version: "23.x"
```

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`)

```yaml
- name: Install Protoc
uses: arduino/setup-protoc@v1
uses: arduino/setup-protoc@v2
with:
version: "3.x"
version: "23.x"
include-pre-releases: true
```

To pin the exact version:

```yaml
- name: Install Protoc
uses: arduino/setup-protoc@v1
uses: arduino/setup-protoc@v2
with:
version: "3.9.1"
version: "23.2"
```

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

```yaml
- name: Install Protoc
uses: arduino/setup-protoc@v1
uses: arduino/setup-protoc@v2
with:
repo-token: ${{ secrets.GITHUB_TOKEN }}
```
Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "setup-protoc-action",
"version": "1.2.0",
"version": "2.0.0",
"private": true,
"description": "Setup protoc action",
"main": "lib/main.js",
Expand Down

0 comments on commit 9b1ee5b

Please sign in to comment.