Feature/prepare commit msg test

.codacy.yaml

@@ -1,3 +1,3 @@
 exclude_paths:
   - 'tests/**'
-  - 'docs/**'
+  - 'docs/**'

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,44 @@
+---
+name: 🛠 Bug report
+about: Create a report to help us improve
+title: "Good bug title tells us about precise symptom, not about the root cause."
+labels: "bug"
+assignees: ""
+---
+
+## Description
+<!-- A clear and concise description of what the bug is. -->
+
+## Steps to reproduce
+<!-- Steps to reproduce the behavior:
+1. Run ...
+2. ...
+3. ... -->
+
+## Current behavior
+<!-- What happens actually so you think this is a bug. -->
+
+## Desired behavior
+<!--
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+-->
+
+## Environment
+<!--
+For older commitizen versions, please include the
+output of the following commands manually:
+
+cz version
+python --version
+python3 -c "import platform; print(platform.system())"
+-->
+Add output of the following command to include the following
+- commitizen version:
+- python version:
+- operating system:
+```bash
+cz version --report
+```

.github/ISSUE_TEMPLATE/documentation.md

@@ -0,0 +1,19 @@
+---
+name: 📖 Documentation
+about: Suggest an improvement for the documentation of this project
+title: "Content to be added or fixed"
+labels: "documentation"
+assignees: ""
+---
+
+## Type
+
+* [ ] Content inaccurate
+* [ ] Content missing
+* [ ] Typo
+
+## URL
+<!-- URL to the code we did not clearly describe or the document page where the content is inaccurate -->
+
+## Description
+<!-- A clear and concise description of what content should be added or fixed -->

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,19 @@
+---
+name: 🚀 Feature request
+about: Suggest an idea for this project
+title: "<One feature request per issue>"
+labels: "feature"
+assignees: ""
+---
+
+## Description
+<!-- A clear and concise description for us to know your idea. -->
+
+## Possible Solution
+<!-- A clear and concise description of what you want to happen. -->
+
+## Additional context
+<!-- Add any other context or screenshots about the feature request here. -->
+
+## Related Issue
+<!-- If applicable, add link to existing issue also help us know better. -->

.github/pull_request_template.md

@@ -0,0 +1,29 @@
+<!--
+Thanks for sending a pull request!
+Please fill in the following content to let us know better about this change.
+-->
+
+## Description
+<!-- Describe what the change is -->
+
+
+## Checklist
+
+- [ ] Add test cases to all the changes you introduce
+- [ ] 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
+
+## Expected behavior
+<!-- A clear and concise description of what you expected to happen -->
+
+
+## Steps to Test This Pull Request
+<!-- Steps to reproduce the behavior:
+1. ...
+2. ...
+3. ... -->
+
+
+## Additional context
+<!-- Add any other RELATED ISSUE, context or screenshots about the pull request here. -->

.github/workflows/bumpversion.yml

@@ -6,36 +6,17 @@ on:
       - master
 
 jobs:
-  build:
-    if: "!contains(github.event.head_commit.message, 'bump')"
+  bump-version:
+    if: "!startsWith(github.event.head_commit.message, 'bump:')"
     runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        python-version: ['3.x']
+    name: "Bump version and create changelog with commitizen"
     steps:
-    - uses: actions/checkout@v2
-      with:
-        token: '${{ secrets.PERSONAL_ACCESS_TOKEN }}'
-        fetch-depth: 0
-    - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v1
-      with:
-        python-version: ${{ matrix.python-version }}
-    - name: Install dependencies
-      run: |
-        python --version
-        python -m pip install -U commitizen
-    - name: Configure repo
-      run: |
-        git config --local user.email "[email protected]"
-        git config --local user.name "GitHub Action"
-        git pull origin master --tags
-    - name: Create bump
-      run: |
-        cz bump --yes
-        git tag
-    - name: Push changes
-      uses: Woile/github-push-action@master
-      with:
-        github_token: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
-        tags: "true"
+      - name: Check out
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+          token: '${{ secrets.PERSONAL_ACCESS_TOKEN }}'
+      - name: Create bump and changelog
+        uses: commitizen-tools/commitizen-action@master
+        with:
+          github_token: ${{ secrets.PERSONAL_ACCESS_TOKEN }}

.github/workflows/docspublish.yaml

@@ -0,0 +1,33 @@
+name: Publish documentation
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  publish-documentation:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        token: '${{ secrets.PERSONAL_ACCESS_TOKEN }}'
+        fetch-depth: 0
+    - name: Set up Python
+      uses: actions/setup-python@v1
+      with:
+        python-version: '3.x'
+    - name: Install dependencies
+      run: |
+        python -m pip install -U mkdocs mkdocs-material
+    - name: Build docs
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      run: |
+        python -m mkdocs build
+    - name: Push doc to Github Page
+      uses: peaceiris/actions-gh-pages@v2
+      env:
+        PERSONAL_TOKEN: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
+        PUBLISH_BRANCH: gh-pages
+        PUBLISH_DIR: ./site

.github/workflows/homebrewpublish.yaml

@@ -0,0 +1,32 @@
+name: Publish to Homebrew
+
+on:
+  workflow_run:
+    workflows: ["Upload Python Package"]
+    types:
+      - completed
+
+jobs:
+  deploy:
+    runs-on: macos-latest
+    if: ${{ github.event.workflow_run.conclusion == 'success' }}
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v2
+    - name: Set up Python
+      uses: actions/setup-python@v1
+      with:
+        python-version: '3.x'
+    - name: Install dependencies
+      run: |
+        python -m pip install -U commitizen
+    - name: Set Project version env variable
+      run: |
+        echo "project_version=$(cz version --project)" >> $GITHUB_ENV
+    - name: Update Homebrew formula
+      uses: dawidd6/action-homebrew-bump-formula@v3
+      with:
+        token: ${{secrets.PERSONAL_ACCESS_TOKEN}}
+        formula: commitizen
+        tag: v${{ env.project_version }}
+        force: true

.github/workflows/pythonpackage.yml

@@ -3,26 +3,26 @@ name: Python package
 on: [pull_request]
 
 jobs:
-  build:
-
-    runs-on: ubuntu-latest
+  python-check:
     strategy:
-      max-parallel: 4
       matrix:
-        python-version: [3.6, 3.7, 3.8]
-
+        python-version: [3.6, 3.8, 3.9]
+        platform: [ubuntu-latest, macos-latest, windows-latest]
+    runs-on: ${{ matrix.platform }}
     steps:
-    - uses: actions/checkout@v1
+    - uses: actions/checkout@v2
+      with:
+        fetch-depth: 0
     - name: Set up Python ${{ matrix.python-version }}
       uses: actions/setup-python@v1
       with:
         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 "[email protected]"
         git config --global user.name "GitHub Action"

.github/workflows/pythonpublish.yaml

@@ -19,20 +19,12 @@ 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: Build and publish
+    - name: Publish
       env:
         PYPI_USERNAME: ${{ secrets.PYPI_USERNAME }}
         PYPI_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       run: |
         ./scripts/publish
-        poetry run mkdocs build
-    - name: Push doc to Github Page
-      uses: peaceiris/actions-gh-pages@v2
-      env:
-        PERSONAL_TOKEN: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
-        PUBLISH_BRANCH: gh-pages
-        PUBLISH_DIR: ./site

.gitignore

@@ -104,6 +104,7 @@ venv.bak/
 # mypy
 .mypy_cache/
 
+.idea
 .vscode/
 *.bak
 

.pre-commit-config.yaml

@@ -0,0 +1,34 @@
+default_stages: [push]
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v3.1.0
+    hooks:
+      - id: check-vcs-permalinks
+      - id: end-of-file-fixer
+        exclude: "tests/[test_*|data]/*"
+      - id: trailing-whitespace
+        args: [--markdown-linebreak-ext=md]
+      - id: debug-statements
+      - id: no-commit-to-branch
+
+  - repo: https://github.com/Woile/commitizen
+    rev: v1.23.0
+    hooks:
+      - id: commitizen
+        stages: [commit-msg]
+
+  - repo: local
+    hooks:
+      - id: format
+        name: format
+        language: system
+        pass_filenames: false
+        entry: ./scripts/format
+        types: [python]
+
+      - id: linter and test
+        name: linter and test
+        language: system
+        pass_filenames: false
+        entry: ./scripts/test
+        types: [python]

.pre-commit-hooks.yaml

@@ -6,3 +6,11 @@
   language_version: python3
   require_serial: true
   minimum_pre_commit_version: "0.15.4"
+- id: commitizen-prepare-commit-msg
+  name: commitizen prepare commit msg
+  description: "prepare commit message"
+  entry: cz commit --commit-msg-file
+  language: python
+  language_version: python3
+  require_serial: true
+  minimum_pre_commit_version: "0.15.4"