From 9b1ee5b22b0a3f1feb8c2ff99b32c89b3c3191e9 Mon Sep 17 00:00:00 2001 From: Alessio Perugini Date: Wed, 31 May 2023 10:12:31 +0200 Subject: [PATCH] v2 release note (#82) --- README.md | 20 ++++++++++++-------- package-lock.json | 4 ++-- package.json | 2 +- 3 files changed, 15 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index b3da8af3..c0b005f0 100644 --- a/README.md +++ b/README.md @@ -14,31 +14,35 @@ 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 ``` @@ -46,9 +50,9 @@ 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, @@ -56,7 +60,7 @@ 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 }} ``` diff --git a/package-lock.json b/package-lock.json index 8143f6b9..7208acb4 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "setup-protoc-action", - "version": "1.2.0", + "version": "2.0.0", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "setup-protoc-action", - "version": "1.2.0", + "version": "2.0.0", "license": "MIT", "dependencies": { "@actions/core": "^1.10.0", diff --git a/package.json b/package.json index b6c38380..38eeaa54 100644 --- a/package.json +++ b/package.json @@ -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",