This project provides Git hooks for the pre-commit framework. This project has several hooks, each of which is explained below.
Install pre-commit base this guide: pre-commit installation guide
run_scripts allows you to execute a set of related scripts with a title and a
condition. This hook receives a list of files and folders in its parameter and collects the set of scripts from the
folders. Then, it executes them and makes sure that all the scripts complete successfully. If a script encounters an
error and exits with a non-zero code, the hook displays the details of the error. This hook is reliable and designed
specifically for this purpose.
Question: What should you do if you have one or more related scripts that you want to run with a specific title and condition?
Basic solution: You could create a script file and place each script inside it. However, this approach may require manually adding scripts from different folders or writing a script to gather all the files in a folder before executing them. Additionally, controlling the outputs can be challenging. While this approach is viable, it can be troublesome, error-prone, lacks specific versioning, and isn't easy to manage across different projects.
Better solution: Use this hook. It takes a list of files and folders as parameters, collects the set of scripts from the specified folders, and executes them, ensuring that all scripts run successfully. If a script encounters an error and exits with a non-zero code, the hook displays the error details. It is a thoroughly tested, reliable, and purpose-built solution.
run_scripts hook is compatible with Python 3.8 and later versions.
To use run_scripts hook in your project, you need to:
- Install pre-commit framework on your system. You can do this by
running
pip install pre-commit. - Add the following code to your
.pre-commit-config.yamlfile:
- repo: https://github.com/Payadel/pre-commit-hooks
rev: v0.1.7 # Ensure it is latest
hooks:
- id: run_scripts
args: [ '-f=path/to/file', '-d=path/to/directory' ]
stages: [ push ]
pass_filenames: false
- Run
pre-commit installto install the hook.
- Allows you to execute related scripts with a title and a condition
- Collects scripts from folders and executes them
- Makes sure all scripts complete successfully
- Displays details of any errors encountered during execution
Before each push, document-oriented makes sure that if the source has changed, at least one document file has been
updated, otherwise it stops the push and reminds that the document needs to be updated as well. You can specify the
pattern of sources and
documents for this hook.
Documentation is a crucial component of any project. To ensure that your project is visible, used, and has contributors, it must have a comprehensive and up-to-date documentation. It is essential to update the relevant documents after making changes to the code without delay.
While most developers understand the significance of documentation, they may occasionally forget or procrastinate updating it. This issue is particularly prevalent in projects with multiple active programmers that are developed over an extended period.
To help you tackle this problem, this hook can be used. If your documents are in your code repository, you can specify the pattern of sources and documents using this hook. Before each push, this hook checks all the commits that are going to be pushed. If the source has been modified, it ensures that at least one document has been updated; otherwise, it halts the push operation and reminds you to update the relevant documents.
document_oriented hook is compatible with Python 3.8 and later versions.
To use document_oriented hook in your project, you need to:
- Install pre-commit framework on your system. You can do this by
running
pip install pre-commit. - Add the following code to your
.pre-commit-config.yamlfile:
- repo: https://github.com/Payadel/pre-commit-hooks
rev: v0.1.7 # Ensure it is latest
hooks:
- id: document-oriented
args: ['--doc=*.md', '--source=src/*']- Run
pre-commit installto install the hook.
- Ensures that project documentation is up-to-date
- Can specify the pattern of sources and documents
A: You can skip the document update check for certain commits by adding the SKIP=document-oriented flag to
your git commit command. For example:
SKIP=document-oriented git commit -m "Commit message"
Please see the CHANGELOG.md file.
See the open issues for a list of proposed features (and known issues).
- Top Feature Requests ( Add your votes using the 👍 reaction)
- Top Bugs ( Add your votes using the 👍 reaction)
- Newest Bugs
Reach out to the maintainer at one of the following places:
If you want to say thank you or/and support active development of this project:
- Add a GitHub Star to the project.
- Tweet about the project.
- Write interesting articles about the project on Dev.to, Medium or your personal blog.
Together, we can make this project better!
First off, thanks for taking the time to contribute! Contributions are what make the free/open-source community such an amazing place to learn, inspire, and create. Any contributions you make will benefit everybody else and are greatly appreciated.
Please read our contribution guidelines, and thank you for being involved!
The original setup of this repository is by Payadel.
For a full list of all authors and contributors, see the contributors page.
This project follows good practices of security, but 100% security cannot be assured. this project is provided "as is" without any warranty.
For more information and to report security issues, please refer to our security documentation.
This project is licensed under the GPLv3.
See LICENSE for more information.