https://github.com/hadenlabs/action-pre-commit
Contains our custom action for running pre-commit
https://github.com/hadenlabs/action-pre-commit
action docker hadenlabs peru pre-commit pre-commit-hook
Last synced: about 2 months ago
JSON representation
Contains our custom action for running pre-commit
- Host: GitHub
- URL: https://github.com/hadenlabs/action-pre-commit
- Owner: hadenlabs
- License: lgpl-3.0
- Created: 2021-05-06T07:22:19.000Z (about 5 years ago)
- Default Branch: develop
- Last Pushed: 2022-02-28T03:51:58.000Z (over 4 years ago)
- Last Synced: 2025-10-12T13:03:47.972Z (8 months ago)
- Topics: action, docker, hadenlabs, peru, pre-commit, pre-commit-hook
- Language: JavaScript
- Homepage:
- Size: 271 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: docs/contributing.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: docs/code_of_conduct.md
Awesome Lists containing this project
README
[](https://github.com/hadenlabs/action-pre-commit/releases) [](https://github.com/hadenlabs/action-pre-commit/actions?workflow=lint-code) [](https://github.com/hadenlabs/action-pre-commit/actions?workflow=test) [](https://github.com/hadenlabs/action-pre-commit/actions?workflow=cd) [](https://github.com/pre-commit/pre-commit) [](https://conventionalcommits.org) [](https://keepachangelog.com)
# action-pre-commit
a GitHub action to run [pre-commit](https://pre-commit.com)
## Requirements
This is a list of plugins that need to be installed previously to enjoy all the goodies of this configuration:
- [docker](https://www.docker.com)
- [python](https://www.python.org)
- [taskfile](https://github.com/go-task/task)
## Usage
To use this action, make a file `.github/workflows/pre-commit.yml`. Here's a
template to get started:
```yaml
name: pre-commit
on:
pull_request:
push:
branches: [main]
jobs:
pre-commit:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: hadenlabs/action-pre-commit@0.2.0
with:
args: run --files
```
## Help
**Got a question?**
File a GitHub [issue](https://github.com/hadenlabs/action-pre-commit/issues).
## Contributing
### Bug Reports & Feature Requests
Please use the [issue tracker](https://github.com/hadenlabs/action-pre-commit/issues) to report any bugs or file feature requests.
### Development
In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
1. **Fork** the repo on GitHub
2. **Clone** the project to your own machine
3. **Commit** changes to your own branch
4. **Push** your work back up to your fork
5. Submit a **Pull Request** so that we can review your changes
**NOTE:** Be sure to rebase the latest changes from "upstream" before making a pull request!
## Module Versioning
This Module follows the principles of [Semantic Versioning (SemVer)](https://semver.org/).
Using the given version number of `MAJOR.MINOR.PATCH`, we apply the following constructs:
1. Use the `MAJOR` version for incompatible changes.
1. Use the `MINOR` version when adding functionality in a backwards compatible manner.
1. Use the `PATCH` version when introducing backwards compatible bug fixes.
### Backwards compatibility in `0.0.z` and `0.y.z` version
- In the context of initial development, backwards compatibility in versions `0.0.z` is **not guaranteed** when `z` is
increased. (Initial development)
- In the context of pre-release, backwards compatibility in versions `0.y.z` is **not guaranteed** when `y` is
increased. (Pre-release)
## Copyright
Copyright © 2018-2021 [Hadenlabs](https://hadenlabs.com)
## Trademarks
All other trademarks referenced herein are the property of their respective owners.
## License
The code and styles are licensed under the LGPL-3.0 license [See project license.](LICENSE).
## Don't forget to 🌟 Star 🌟 the repo if you like action-pre-commit
[Your feedback is appreciated](https://github.com/hadenlabs/action-pre-commit/issues)