Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/arduino/setup-protoc
GitHub Action to setup the protoc compiler for protocol buffers
https://github.com/arduino/setup-protoc
arduino github-actions protoc tooling-team
Last synced: about 1 month ago
JSON representation
GitHub Action to setup the protoc compiler for protocol buffers
- Host: GitHub
- URL: https://github.com/arduino/setup-protoc
- Owner: arduino
- License: gpl-3.0
- Created: 2019-10-22T11:30:34.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-09-03T20:27:46.000Z (2 months ago)
- Last Synced: 2024-09-07T16:33:50.647Z (2 months ago)
- Topics: arduino, github-actions, protoc, tooling-team
- Language: TypeScript
- Homepage:
- Size: 1.74 MB
- Stars: 134
- Watchers: 9
- Forks: 57
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# setup-protoc
[](https://github.com/arduino/setup-protoc/actions/workflows/check-npm-dependencies-task.yml)
[](https://github.com/arduino/setup-protoc/actions/workflows/sync-labels-npm.yml)
[](https://github.com/arduino/setup-protoc/actions/workflows/check-markdown-task.yml)
[](https://github.com/arduino/setup-protoc/actions/workflows/check-license.yml)
[](https://github.com/arduino/setup-protoc/actions/workflows/check-taskfiles.yml)
[](https://github.com/arduino/setup-protoc/actions/workflows/test-integration.yml)
[](https://github.com/arduino/setup-protoc/actions/workflows/check-npm-task.yml)
[](https://github.com/arduino/setup-protoc/actions/workflows/check-typescript-task.yml)
[](https://github.com/arduino/setup-protoc/actions/workflows/check-tsconfig-task.yml)
[](https://github.com/arduino/setup-protoc/actions/workflows/check-packaging-ncc-typescript-task.yml)
This action makes the `protoc` compiler available to Workflows.
## Upgrade from v1 to v2 or v3
Added support **only** for the new protobuf tag naming convention `MINOR.PATCH`.
## Usage
To get the latest stable version of `protoc` just add this step:
```yaml
- name: Install Protoc
uses: arduino/setup-protoc@v3
```
If you want to pin a major or minor version you can use the `.x` wildcard:
```yaml
- name: Install Protoc
uses: arduino/setup-protoc@v3
with:
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@v3
with:
version: "23.x"
include-pre-releases: true
```
To pin the exact version:
```yaml
- name: Install Protoc
uses: arduino/setup-protoc@v3
with:
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@v3
with:
repo-token: ${{ secrets.GITHUB_TOKEN }}
```
## Enable verbose logging for a pipeline
Additional log events with the prefix ::debug:: can be enabled by setting the secret `ACTIONS_STEP_DEBUG` to `true`.
See [step-debug-logs](https://github.com/actions/toolkit/blob/master/docs/action-debugging.md#step-debug-logs) for reference.
## Security
If you think you found a vulnerability or other security-related bug in this project, please read our
[security policy](https://github.com/arduino/setup-protoc/security/policy) and report the bug to our Security Team 🛡️
Thank you!
e-mail contact: [email protected]
## Contributing
To report bugs or make feature requests, please submit an issue: https://github.com/arduino/setup-protoc/issues
Pull requests are welcome! Please see the [contribution guidelines](.github/CONTRIBUTING.md) for information.