Skip to content

Use v1 ref in examples #10

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.

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 1 commit into from
Aug 3, 2020
Merged
Changes from all commits
Commits
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
15 changes: 10 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,14 @@ To get the latest stable version of `protoc` just add this step:

```yaml
- name: Install Protoc
uses: arduino/setup-protoc@master
uses: arduino/setup-protoc@v1
```

If you want to pin a major or minor version you can use the `.x` wildcard:

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

```yaml
- name: Install Protoc
uses: arduino/setup-protoc@master
uses: arduino/setup-protoc@v1
with:
version: '3.x'
include-pre-releases: true
Expand All @@ -36,7 +36,7 @@ To pin the exact version:

```yaml
- name: Install Protoc
uses: arduino/setup-protoc@master
uses: arduino/setup-protoc@v1
with:
version: '3.9.1'
```
Expand All @@ -46,7 +46,7 @@ pass the default token with the `repo-token` variable:

```yaml
- name: Install Protoc
uses: arduino/setup-protoc@master
uses: arduino/setup-protoc@v1
with:
repo-token: ${{ secrets.GITHUB_TOKEN }}
```
Expand Down Expand Up @@ -86,4 +86,9 @@ Action the workflow should be the following:
1. `rm -rf node_modules` to remove all the dependencies.
1. `npm install --production` to add back **only** the runtime dependencies.
1. `git add lib node_modules` to check in the code that matters.
1. If the release will increment the major version, update the action refs in the examples in README.md
(e.g., `uses: arduino/setup-protoc@v1` -> `uses: arduino/setup-protoc@v2`).
1. open a PR and request a review.
1. After PR is merged, create a release, following the `vX.X.X` tag name convention.
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.
If no branch exists for the release's major version, create one.