https://github.com/frequenz-floss/gh-action-protolint

An opinionated pre-configured version of https://github.com/yoheimuta/action-protolint
https://github.com/frequenz-floss/gh-action-protolint

Last synced: 10 months ago
JSON representation

An opinionated pre-configured version of https://github.com/yoheimuta/action-protolint

• Host: GitHub
• URL: https://github.com/frequenz-floss/gh-action-protolint
• Owner: frequenz-floss
• License: mit
• Created: 2024-02-20T13:03:16.000Z (over 2 years ago)
• Default Branch: v0.x.x
• Last Pushed: 2024-02-23T14:00:35.000Z (over 2 years ago)
• Last Synced: 2025-03-22T23:27:52.518Z (about 1 year ago)
• Size: 5.86 KB
• Stars: 0
• Watchers: 1
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Protolint Action

This action runs [protolint](https://github.com/yoheimuta/protolint) using the

[action-protolint](https://github.com/yoheimuta/action-protolint) GitHub

Action with a custom configuration used in most Frequenz projects.

Here is an example demonstrating how to use it in a workflow:

```yaml

jobs:

  protolint:

    name: Check proto files with protolint

    runs-on: ubuntu-20.04

    steps:

      - name: Run protolint

        uses: frequenz-io/gh-action-protolint@v0.x.x

```

By default, the action will checkout submodules (non-recursively) and use the

`secrets.github_token` to do both the fetching and to do GitHub API calls to

comment in PRs for example. It looks for proto files in the `proto/` directory

and uses a fixed protolint version (please look at the

[`action.yml`](./action.yml) file for the current version).

You can change those defaults using custom inputs. For example:

```yaml

jobs:

  protolint:

    name: Check proto files with protolint

    runs-on: ubuntu-20.04

    steps:

      - name: Run protolint

        uses: frequenz-io/gh-action-protolint@v0.x.x

        with:

          submodules: recursive

          checkout_token: ${{ secrets.my_checkout_token }}

          api_token: ${{ secrets.my_api_token }}

          protolint_flags: "-config_path=.github/protolint.yaml proto/"

          protolint_version: "v0.46.0"

```