A GitHub action to run pre-commit

Introduction

This action is a fork of pre-commit/action that adds optional features for private repositories.

Permissions required: repo and workflow.

Usage

name: pre-commit

on:
  pull_request:
  push:
    branches: [main]

jobs:
  pre-commit:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-python@v5
      - uses: cloudposse/github-action-pre-commit@v4.0.0

To run a specific hook or pass custom arguments:

- uses: cloudposse/github-action-pre-commit@v4.0.0
  with:
    extra_args: flake8 --all-files

For private repositories, configure push-back support:

- uses: actions/checkout@v4
  with:
    fetch-depth: 0

- uses: cloudposse/github-action-pre-commit@v4.0.0
  with:
    token: ${{ secrets.GITHUB_TOKEN }}
    git_user_name: pre-commit
    git_user_email: pre-commit@users.noreply.github.com
    git_commit_message: pre-commit fixes

Inputs

Name	Description	Default	Required
extra_args	options to pass to pre-commit run	--all-files	false
git_commit_message	github commit message to push with	pre-commit fixes	false
git_user_email	github user email to push with	pre-commit@example.com	false
git_user_name	github user name to push with	pre-commit	false
token	github token to clone / push with	N/A	false

Related Projects

Check out these related projects.

References

For additional context, refer to some of these links.

• github-actions-workflows - Reusable workflows for different types of projects

✨ Contributing

This project is under active development, and we encourage contributions from our community.

Many thanks to our outstanding contributors:

For 🐛 bug reports & feature requests, please use the issue tracker.

In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.

1. Review our Code of Conduct and Contributor Guidelines.
2. Fork the repo on GitHub
3. Clone the project to your own machine
4. Commit changes to your own branch
5. Push your work back up to your fork
6. Submit a Pull Request so that we can review your changes

NOTE: Be sure to merge the latest changes from "upstream" before making a pull request!

🌎 Slack Community

Join our Open Source Community on Slack. It's FREE for everyone! Our "SweetOps" community is where you get to talk with others who share a similar vision for how to rollout and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build totally sweet infrastructure.

📰 Newsletter

Sign up for our newsletter and join 3,000+ DevOps engineers, CTOs, and founders who get insider access to the latest DevOps trends, so you can always stay in the know. Dropped straight into your Inbox every week — and usually a 5-minute read.

📆 Office Hours

Join us every Wednesday via Zoom for your weekly dose of insider DevOps trends, AWS news and Terraform insights, all sourced from our SweetOps community, plus a live Q&A that you can’t find anywhere else. It's FREE for everyone!

License

Preamble to the Apache License, Version 2.0

Complete license is available in the LICENSE file.

Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License.  You may obtain a copy of the License at

  https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.

Trademarks

All other trademarks referenced herein are the property of their respective owners.

---

Copyright © 2017-2026 Cloud Posse, LLC