README.md

GitHub Action for TODO group's Repolinter!

This Action wraps repolinter allowing easy linting of your repository!

Contents

• Inputs
• Environment Variables
• Example Usage
  • Vanilla
  • Custom File
• License

Inputs

• args - Optional. These are the arguments to pass to the repolinter CLI.

Environment Variables

• CUSTOM_REPOLINT_FILE - Optional. You can override the default configuration. See todogroup/repolinter for more info on that.

Example Usage

Vanilla

repolinter CLI will automatically lint your repository`:

name: Lint repository
on: [push]

jobs:
  repo-lint:
    name: "repolint"
    runs-on: ubuntu-latest
    steps:
      - name: "checkout repo"
        uses: actions/checkout@v2.0.0
        with:
          fetch-depth: 0
      - name: Test repolinter
        uses: philips-labs/github-action-repolinter@master

Custom configuration file:

Specify the configuration file:

name: Lint repository
on: [push]

jobs:
  repo-lint-custom:
    name: "repolint custom"
    runs-on: ubuntu-latest
    steps:
      - name: "checkout repo"
        uses: actions/checkout@v2.0.0
        with:
          fetch-depth: 0
      - name: Test repolinter
        uses: philips-labs/github-action-repolinter@master
        env:
          CUSTOM_REPOLINT_FILE: repolint.json

Scan external git repository

Specify the configuration file:

name: Lint repository
on: [push]

jobs:
  repo-lint-git:
    name: "repolint git"
    runs-on: ubuntu-latest
    steps:
      - name: Test repolinter
        uses: philips-labs/github-action-repolinter@master
        with:
          args: --git https://github.com/philips-labs/garo

Scan external git repository and custom configuration

Specify the configuration file:

name: Lint repository
on: [push]

jobs:
  repo-lint-git-custom:
    name: "repolint git custom"
    runs-on: ubuntu-latest
    steps:
      - name: "checkout repo"
        uses: actions/checkout@v2.0.0
        with:
          fetch-depth: 0
      - name: Test repolinter
        uses: philips-labs/github-action-repolinter@master
        with:
          args: --git https://github.com/philips-labs/garo
        env:
          CUSTOM_REPOLINT_FILE: repolint.json

Examples

example repo

Contributors

Thanks goes to these contributors!

License

MIT License