Proposal: Dev & CI workflow improvement

.github/pull_request_template.md

@@ -10,7 +10,7 @@ Please fill in the following content to let us know better about this change.
 ## Checklist
 
 - [ ] Add test cases to all the changes you introduce
-- [ ] Run `./scripts/format` and `./scripts/test` locally to ensure this change passes linter check and test
+- [ ] Run `poetry all` 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/docspublish.yml

@@ -19,12 +19,12 @@ jobs:
           python-version: "3.x"
       - name: Install dependencies
         run: |
-          python -m pip install -U pip poetry
+          python -m pip install -U pip poetry poethepoet
           poetry --version
-          poetry install
+          poetry install --only main,script
       - name: Update CLI screenshots
         run: |
-          poetry run python scripts/gen_cli_help_screenshots.py
+          poetry doc:screenshots
       - name: Commit and push updated CLI screenshots
         run: |
           git config --global user.name "github-actions[bot]"
@@ -55,12 +55,14 @@ jobs:
           python-version: "3.x"
       - name: Install dependencies
         run: |
-          python -m pip install -U mkdocs mkdocs-material
+          python -m pip install -U pip poetry poethepoet
+          poetry --version
+          poetry install --no-root --only documentation
       - name: Build docs
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         run: |
-          python -m mkdocs build
+          poetry doc:build
       - name: Generate Sponsors 💖
         uses: JamesIves/github-sponsors-readme-action@v1
         with:

.github/workflows/pythonpackage.yml

@@ -19,14 +19,14 @@ jobs:
           python-version: ${{ matrix.python-version }}
       - name: Install dependencies
         run: |
-          python -m pip install -U pip poetry
+          python -m pip install -U pip poetry poethepoet
           poetry --version
-          poetry install
+          poetry install --only main,linters,test
       - name: Run tests and linters
         run: |
           git config --global user.email "[email protected]"
           git config --global user.name "GitHub Action"
-          SKIP=no-commit-to-branch,commitizen-branch poetry run pre-commit run --all-files --hook-stage pre-push
+          poetry ci
         shell: bash
       - name: Upload coverage to Codecov
         if: runner.os == 'Linux'

.github/workflows/pythonpublish.yml

@@ -19,12 +19,10 @@ jobs:
           python-version: "3.x"
       - name: Install dependencies
         run: |
-          python -m pip install -U pip poetry mkdocs mkdocs-material
+          python -m pip install -U pip poetry
           poetry --version
-          poetry install
       - name: Publish
         env:
-          PYPI_USERNAME: ${{ secrets.PYPI_USERNAME }}
-          PYPI_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
-        run: |
-          ./scripts/publish
+          POETRY_HTTP_BASIC_PYPI_USERNAME: ${{ secrets.PYPI_USERNAME }}
+          POETRY_HTTP_BASIC_PYPI_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+        run: poetry publish --build

.pre-commit-config.yaml

@@ -5,7 +5,6 @@ default_install_hook_types:
 
 default_stages:
   - pre-commit
-  - pre-push
 
 repos:
   - repo: meta
@@ -55,21 +54,19 @@ repos:
       - id: commitizen-branch
         stages:
           - post-commit
-          - pre-push
 
   - repo: local
     hooks:
       - id: format
-        name: format
+        name: Format
         language: system
         pass_filenames: false
-        entry: ./scripts/format
+        entry: poetry format
         types: [ python ]
 
       - id: linter and test
-        name: linter and test
+        name: Linters
         language: system
         pass_filenames: false
-        stages: [ pre-push ]
-        entry: ./scripts/test
+        entry: poetry lint
         types: [ python ]

docs/contributing.md

@@ -16,16 +16,16 @@ If you're a first-time contributor, you can check the issues with [good first is
 1. Fork [the repository](https://github.com/commitizen-tools/commitizen).
 2. Clone the repository from your GitHub.
 3. Setup development environment through [poetry](https://python-poetry.org/) (`poetry install`).
-4. Setup [pre-commit](https://pre-commit.com/) hook (`poetry run pre-commit install`)
+4. Setup [pre-commit](https://pre-commit.com/) hook (`poetry setup-pre-commit`)
 5. Check out a new branch and add your modification.
 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. We follow [conventional commits](https://www.conventionalcommits.org/).
-8. Run `./scripts/format` and `./scripts/test` to ensure you follow the coding style and the tests pass.
-9. Optionally, update the `./docs/README.md` or `docs/images/cli_help` (through running `scripts/gen_cli_help_screenshots.py`).
+8. Run `poetry all` to ensure you follow the coding style and the tests pass.
+9. Optionally, update the `./docs/README.md` or `docs/images/cli_help` (through running `poetry doc:screenshots`).
 9. **Do not** update the `CHANGELOG.md`, it will be automatically created after merging to `master`.
 10. **Do not** update the versions in the project, they will be automatically updated.
-10. If your changes are about documentation. Run `poetry run mkdocs serve` to serve documentation locally and check whether there is any warning or error.
+10. If your changes are about documentation. Run `poetry doc` to serve documentation locally and check whether there is any warning or error.
 11. Send a [pull request](https://github.com/commitizen-tools/commitizen/pulls) 🙏
 
 ## Use of GitHub Labels