Google Git
Sign in
apache / airflow-pre-commit-action / cbf0c679a914160b80dfd8b53c4f50110c407c54
commitcbf0c679a914160b80dfd8b53c4f50110c407c54[log] [tgz]
authorAnthony Sottile <asottile@umich.edu>Thu May 07 17:16:05 2020 -0700
committerGitHub <noreply@github.com>Thu May 07 17:16:05 2020 -0700
tree94c5588ef2bba8f88cf30d5f0f7f466f16d4a221
parent80db042ff08cdddbbbfb6f89c06a6bfc4dddf0b7 [diff]
parent0ed43356a69548f73d1d6cd26343edcf1ee539eb [diff]
Merge pull request #20 from pradyunsg/patch-1

Update example to newer actions/* versions
tree: 94c5588ef2bba8f88cf30d5f0f7f466f16d4a221
  1. .github/
  2. .gitignore
  3. .pre-commit-config.yaml
  4. action.yml
  5. index.js
  6. Makefile
  7. package-lock.json
  8. package.json
  9. README.md
  10. webpack.config.js
README.md

Build Status

pre-commit/action

a GitHub action to run pre-commit

using this action

To use this action, make a file .github/workflows/pre-commit.yml. Here's a template to get started:

name: pre-commit

on:
  pull_request:
  push:
    branches: [master]

jobs:
  pre-commit:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2
    - uses: actions/setup-python@v2
    - name: set PY
      run: echo "::set-env name=PY::$(python -c 'import hashlib, sys;print(hashlib.sha256(sys.version.encode()+sys.executable.encode()).hexdigest())')"
    - uses: actions/cache@v1
      with:
        path: ~/.cache/pre-commit
        key: pre-commit|${{ env.PY }}|${{ hashFiles('.pre-commit-config.yaml') }}
    - uses: pre-commit/action@v1.0.1

This does a few things:

  • clones the code
  • installs python
  • sets up the pre-commit cache

Hopefully in the future when actions matures the yaml can be simplified.

using this action in private repositories

this action also provides an additional behaviour when used in private repositories. when configured with a github token, the action will push back fixes to the pull request branch.

here's an example configuration for that (use the template above except for the pre-commit action):

    - uses: pre-commit/action@v1.0.1
      with:
        token: ${{ secrets.GITHUB_TOKEN }}

note that secrets.GITHUB_TOKEN is automatically provisioned and will not require any special configuration.

while you could technically configure this for a public repository (using a personal access token), I can't think of a way to do this safely without exposing a privileged token to pull requests -- if you have any ideas, please leave an issue!