Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dayyass/git-hooks-is-all-you-need
Git Hooks Tutorial.
https://github.com/dayyass/git-hooks-is-all-you-need
automation ci devops git git-hooks pre-commit python
Last synced: 24 days ago
JSON representation
Git Hooks Tutorial.
- Host: GitHub
- URL: https://github.com/dayyass/git-hooks-is-all-you-need
- Owner: dayyass
- Created: 2021-08-29T09:02:32.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2022-07-06T07:25:22.000Z (over 2 years ago)
- Last Synced: 2023-03-06T20:35:49.935Z (over 1 year ago)
- Topics: automation, ci, devops, git, git-hooks, pre-commit, python
- Language: Python
- Homepage:
- Size: 17.6 KB
- Stars: 18
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Git Hooks Tutorial
My public talk about this project at Sberloga:
[**Git Hooks Is All You Need**](https://youtu.be/92OMAtdVIAs)
### 1. Git Hooks 101
1) Init git repo:
```shell script
mkdir git_repo
cd git_repo
git init
```
2) Git hooks are located in `.git/hooks` folder:
```shell script
ls -lah .git/hooks
```
3) Create executable (`chmod +x`) pre-commit hooks (path: `.git/hooks/pre-commit`):
- bash [hook](https://github.com/dayyass/git_hooks_is_all_you_need/blob/main/hooks/pre-commit.good) with exit code 0
- bash [hook](https://github.com/dayyass/git_hooks_is_all_you_need/blob/main/hooks/pre-commit.bad) with exit code 1
- python [hook](https://github.com/dayyass/git_hooks_is_all_you_need/blob/main/hooks/pre-commit.good.py) with exit code 0
Make commit after each step. You'll see different results.
### 2. Python pre-commit library
1) Create and activate virtual environment:
```shell script
python3 -m venv venv
source venv/bin/activate
```
2) Install and activate pre-commit library:
```shell script
pip install pre-commit
pre-commit install
```
3) Create pre-commit configuration file [.pre-commit-config.yaml](https://github.com/dayyass/git_hooks_is_all_you_need/blob/main/.pre-commit-config.yaml).
Alternatively, you can use [local configuration](https://github.com/dayyass/git_hooks_is_all_you_need/blob/main/.pre-commit-config_local.yaml).
4) Create [main.py](https://github.com/dayyass/git_hooks_is_all_you_need/blob/main/main_before_hooks.py) file.
Make commit. Pre-commit library will reformat file according to PEP8.
Remove unused `import sys` string to get ready-to-commit [main.py](https://github.com/dayyass/git_hooks_is_all_you_need/blob/main/main_after_hooks.py) file.
### 3. Remote repo
1) Init empty "remote" repo:
```shell script
git init --bare ../remote_repo.git
```
2) Link local and "remote" repo:
```shell script
git remote add origin ../remote_repo.git
```
3) Create executable (`chmod +x`) pre-receive [hook](https://github.com/dayyass/git_hooks_is_all_you_need/blob/main/hooks/pre-receive.good) on "remote" (path: `../remote_repo.git/hooks/pre-receive`).
Make push and see the result.
### Reference
Useful links:
- git hooks intro: [link](https://githooks.com)
- git hooks usage: [link](https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks)
- pre-commit page: [link](https://pre-commit.com)
### Thanks
Thanks to [Anastasiya](https://github.com/TabalinaAnastasia) for help with jupyter notebook hooks!