Merge pull request #218 from commitizen-tools/fix-pre-commit-config-doc

docs(README): add "pre-commit install --hook-type commit-msg" command

Author: Lee-W

.github/pull_request_template.md

@@ -15,7 +15,7 @@ Please put an `x` in the box that applies
 
 ## Checklist:
 - [ ] Add test cases to all the changes you introduce
-- [ ] Run `./script/reformat` and `./script/test` locally to ensure this change passes linter check and test
+- [ ] Run `./script/format` and `./script/test` locally to ensure this change passes linter check and test
 - [ ] Test the changes on the local machine manually
 - [ ] Update the documentation for the changes
 

.github/workflows/bumpversion.yml

@@ -6,7 +6,7 @@ on:
       - master
 
 jobs:
-  build:
+  bump-version:
     if: "!startsWith(github.event.head_commit.message, 'bump:')"
     runs-on: ubuntu-latest
     strategy:
@@ -24,7 +24,7 @@ jobs:
     - name: Install dependencies
       run: |
         python --version
-        python -m pip install -U poetry
+        python -m pip install -U pip poetry
     - name: Configure repo
       run: |
         git config --local user.email "action@github.com"

.github/workflows/docspublish.yaml

@@ -6,7 +6,7 @@ on:
       - master
 
 jobs:
-  deploy:
+  publish-documentation:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v2

.github/workflows/pythonpackage.yml

@@ -3,8 +3,7 @@ name: Python package
 on: [pull_request]
 
 jobs:
-  build:
-
+  python-check:
     runs-on: ubuntu-latest
     strategy:
       max-parallel: 4
@@ -21,22 +20,14 @@ jobs:
         python-version: ${{ matrix.python-version }}
     - name: Install dependencies
       run: |
-        python -m pip install --pre -U poetry
+        python -m pip install -U pip poetry
         poetry --version
         poetry install
-    - name: Run tests
+    - name: Run tests and linters
       run: |
         git config --global user.email "action@github.com"
         git config --global user.name "GitHub Action"
         ./scripts/test
-    - name: Check commit
-      run: |
-        poetry run python -m commitizen check --rev-range ${{ github.event.pull_request.base.sha }}..${{ github.event.pull_request.head.sha }} || \
-        if [ $$? == 3 ] ; then
-          exit 0;
-        else
-          exit 1;
-        fi
     - name: Upload coverage to Codecov
       if: runner.os == 'Linux'
       uses: codecov/codecov-action@v1.0.3

.github/workflows/pythonpublish.yaml

@@ -19,7 +19,7 @@ jobs:
         python-version: '3.x'
     - name: Install dependencies
       run: |
-        python -m pip install --pre -U poetry mkdocs mkdocs-material
+        python -m pip install -U pip poetry mkdocs mkdocs-material
         poetry --version
         poetry install
     - name: Publish

.pre-commit-config.yaml

@@ -18,11 +18,11 @@ repos:
 
   - repo: local
     hooks:
-      - id: reformat
-        name: reformat
+      - id: format
+        name: format
         language: system
         pass_filenames: false
-        entry: ./scripts/reformat
+        entry: ./scripts/format
         types: [python]
 
       - id: linter and test

docs/README.md

@@ -88,6 +88,12 @@ repos:
         stages: [commit-msg]
 ```
 
+After the configuration is added, you'll need to run
+
+```sh
+pre-commit install --hook-type commit-msg
+```
+
 Read more about the `check` command [here](https://commitizen-tools.github.io/commitizen/check/).
 
 ### Help

docs/contributing.md

@@ -16,6 +16,6 @@ If you're a first-time contributor, you can check the issues with [good first is
 6. Add test cases for all your changes.
    (We use [CodeCov](https://codecov.io/) to ensure our test coverage does not drop.)
 7. Use [commitizen](https://github.com/commitizen-tools/commitizen) to do git commit.
-8. Run `./scripts/reformat` and `./scripts/test` to ensure you follow the coding style and the tests pass.
+8. Run `./scripts/format` and `./scripts/test` to ensure you follow the coding style and the tests pass.
 9. Update `READMD.md` and `CHANGELOG.md` for your changes.
 10. Send a [pull request](https://github.com/commitizen-tools/commitizen/pulls) 🙏

pyproject.toml

@@ -44,7 +44,7 @@ classifiers = [
 ]
 
 [tool.poetry.dependencies]
-python = "^3.6"
+python = "^3.6.1"
 questionary = "^1.4.0"
 decli = "^0.5.0"
 colorama = "^0.4.1"
@@ -67,6 +67,7 @@ mkdocs-material = "^4.1"
 isort = "^4.3.21"
 freezegun = "^0.3.15"
 pydocstyle = "^5.0.2"
+pre-commit = "^2.6.0"
 
 [tool.poetry.scripts]
 cz = "commitizen.cli:main"