/lite-action

github action for pre-commit-ci lite

Primary LanguagePython

Build Status

action-lite

pre-commit.ci lite is an add-on for GitHub Actions which safely auto fixes PRs

setup

  1. install the GitHub Application on the relevant repositories

  2. add the GitHub action to your workflow as the last step in your job:

        - uses: pre-commit-ci/lite-action@v1.0.1
      if: always()

note: the step must have either the default name or contain the text pre-commit-ci-lite. the application uses this to find the right workflow.

options

  • msg: (default [pre-commit.ci lite] apply automatic fixes): commit message used for auto fixing

        - uses: pre-commit-ci/lite-action@v1.0.1
      if: always()
      with:
        msg: apply code formatting

example using pre-commit/action

technically pre-commit.ci lite works for any code modification, though it was built with pre-commit in mind. here is an example workflow:

on:
  pull_request:
  push:
    branches: [main, test-me-*]

jobs:
  main:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v3
    - uses: actions/setup-python@v4
      with:
        python-version: 3.x
    - uses: pre-commit/action@v3.0.0
    - uses: pre-commit-ci/lite-action@v1.0.1
      if: always()