8000 v2 release note by alessio-perugini · Pull Request #82 · arduino/setup-protoc · GitHub
[go: up one dir, main page]
Skip to content

v2 release note #82

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 31, 2023
Merged

v2 release note #82

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4413044
bump version in package.json
alessio-perugini May 31, 2023
ed6454b
update readme
alessio-perugini May 31, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
update readme
  • Loading branch information
@alessio-perugini
alessio-perugini committed May 31, 2023
commit ed6454b96e5844b980f52c2f44e0b7aebae10a3a
20 changes: 12 additions & 8 deletions README.md
View file
Open in desktop
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
0