chore: Template upgrade

Author: pawamoy

.copier-answers.yml

@@ -1,11 +1,11 @@
 # Changes here will be overwritten by Copier
-_commit: 0.4.4
+_commit: 0.10.2
 _src_path: gh:pawamoy/copier-pdm
 author_email: [email protected]
-author_fullname: "Timoth\xE9e Mazzucotelli"
+author_fullname: Timothée Mazzucotelli
 author_username: pawamoy
 copyright_date: '2020'
-copyright_holder: "Timoth\xE9e Mazzucotelli"
+copyright_holder: Timothée Mazzucotelli
 copyright_holder_email: [email protected]
 copyright_license: ISC License
 project_description: Automatic Changelog generator using Jinja2 templates.
@@ -17,3 +17,4 @@ repository_name: git-changelog
 repository_namespace: pawamoy
 repository_provider: github.com
 use_precommit: false
+

.github/FUNDING.yml

@@ -1,7 +1,4 @@
 github:
-  - pawamoy
-ko_fi: pawamoy
-liberapay: pawamoy
-patreon: pawamoy
+- pawamoy
 custom:
-  - https://www.paypal.me/pawamoy
+- https://www.paypal.me/pawamoy

.github/workflows/ci.yml

@@ -28,7 +28,7 @@ jobs:
       uses: actions/checkout@v2
 
     - name: Set up PDM
-      uses: pdm-project/setup-pdm@v2.5
+      uses: pdm-project/setup-pdm@v2.6
       with:
         python-version: "3.8"
 
@@ -50,15 +50,13 @@ jobs:
       run: pdm lock
 
     - name: Install dependencies
-      run: |
-        pdm install -G duty -G docs -G quality -G typing
-        pip install safety
+      run: pdm install -G duty -G docs -G quality -G typing -G security
 
     - name: Check if the documentation builds correctly
       run: pdm run duty check-docs
 
     - name: Check the code quality
-      run: pdm run duty check-code-quality
+      run: pdm run duty check-quality
 
     - name: Check if the code is correctly typed
       run: pdm run duty check-types
@@ -75,10 +73,11 @@ jobs:
         - macos-latest
         - windows-latest
         python-version:
-        - "3.6"
         - "3.7"
         - "3.8"
         - "3.9"
+        - "3.10"
+        - "3.11-dev"
 
     runs-on: ${{ matrix.os }}
 
@@ -87,7 +86,7 @@ jobs:
       uses: actions/checkout@v2    
 
     - name: Set up PDM
-      uses: pdm-project/setup-pdm@v2.5
+      uses: pdm-project/setup-pdm@v2.6
       with:
         python-version: ${{ matrix.python-version }}
 
@@ -106,7 +105,7 @@ jobs:
         key: tests-cache-${{ runner.os }}-${{ matrix.python-version }}
 
     - name: Install dependencies
-      run: pdm install -G duty -G tests
+      run: pdm install --no-editable -G duty -G tests
 
     - name: Run the test suite
       run: pdm run duty test

.gitpod.dockerfile

@@ -0,0 +1,7 @@
+FROM gitpod/workspace-full
+USER gitpod
+ENV PIP_USER=no
+ENV PYTHON_VERSIONS=
+RUN pip3 install pipx; \
+    pipx install pdm; \
+    pipx ensurepath

.gitpod.yml

@@ -0,0 +1,13 @@
+vscode:
+  extensions:
+  - ms-python.python
+
+image:
+  file: .gitpod.dockerfile
+
+ports:
+- port: 8000
+  onOpen: notify
+
+tasks:
+- init: make setup

CONTRIBUTING.md

@@ -14,21 +14,21 @@ cd git-changelog
 make setup
 ```
 
-!!! note
-    If it fails for some reason,
-    you'll need to install
-    [PDM](https://github.com/pdm-project/pdm)
-    manually.
-
-    You can install it with:
-
-    ```bash
-    python3 -m pip install --user pipx
-    pipx install pdm
-    ```
-
-    Now you can try running `make setup` again,
-    or simply `pdm install`.
+> NOTE:
+> If it fails for some reason,
+> you'll need to install
+> [PDM](https://github.com/pdm-project/pdm)
+> manually.
+> 
+> You can install it with:
+> 
+> ```bash
+> python3 -m pip install --user pipx
+> pipx install pdm
+> ```
+> 
+> Now you can try running `make setup` again,
+> or simply `pdm install`.
 
 You now have the dependencies installed.
 
@@ -57,17 +57,14 @@ As usual:
 1. create a new branch: `git checkout -b feature-or-bugfix-name`
 1. edit the code and/or the documentation
 
-If you updated the documentation or the project dependencies:
-
-1. run `make docs-regen`
-1. run `make docs-serve`,
-   go to http://localhost:8000 and check that everything looks good
-
 **Before committing:**
 
 1. run `make format` to auto-format the code
 1. run `make check` to check everything (fix any warning)
 1. run `make test` to run the tests (fix any issue)
+1. if you updated the documentation or the project dependencies:
+    1. run `make docs-serve`
+    1. go to http://localhost:8000 and check that everything looks good
 1. follow our [commit message convention](#commit-message-convention)
 
 If you are unsure about how to fix or ignore a warning,

Makefile

@@ -4,13 +4,14 @@ SHELL := bash
 DUTY = $(shell [ -n "${VIRTUAL_ENV}" ] || echo pdm run) duty
 
 args = $(foreach a,$($(subst -,_,$1)_args),$(if $(value $a),$a="$($a)"))
-check_code_quality_args = files
+check_quality_args = files
 docs_serve_args = host port
 release_args = version
 test_args = match
 
 BASIC_DUTIES = \
 	changelog \
+	check-dependencies \
 	clean \
 	coverage \
 	docs \
@@ -21,9 +22,7 @@ BASIC_DUTIES = \
 	release
 
 QUALITY_DUTIES = \
-	check \
-	check-code-quality \
-	check-dependencies \
+	check-quality \
 	check-docs \
 	check-types \
 	test
@@ -32,10 +31,19 @@ QUALITY_DUTIES = \
 help:
 	@$(DUTY) --list
 
+.PHONY: lock
+lock:
+	@pdm lock
+
 .PHONY: setup
 setup:
 	@bash scripts/setup.sh
 
+.PHONY: check
+check:
+	@bash scripts/multirun.sh duty check-quality check-types check-docs
+	@$(DUTY) check-dependencies
+
 .PHONY: $(BASIC_DUTIES)
 $(BASIC_DUTIES):
 	@$(DUTY) $@ $(call args,$@)

README.md

@@ -3,6 +3,7 @@
 [![ci](https://github.com/pawamoy/git-changelog/workflows/ci/badge.svg)](https://github.com/pawamoy/git-changelog/actions?query=workflow%3Aci)
 [![documentation](https://img.shields.io/badge/docs-mkdocs%20material-blue.svg?style=flat)](https://pawamoy.github.io/git-changelog/)
 [![pypi version](https://img.shields.io/pypi/v/git-changelog.svg)](https://pypi.org/project/git-changelog/)
+[![gitpod](https://img.shields.io/badge/gitpod-workspace-blue.svg?style=flat)](https://gitpod.io/#https://github.com/pawamoy/git-changelog)
 [![gitter](https://badges.gitter.im/join%20chat.svg)](https://gitter.im/git-changelog/community)
 
 Automatic Changelog generator using Jinja2 templates. From git logs to change logs.
@@ -48,42 +49,17 @@ Automatic Changelog generator using Jinja2 templates. From git logs to change lo
 [issue-17]: https://github.com/pawamoy/git-changelog/issues/17
 [issue-19]: https://github.com/pawamoy/git-changelog/issues/19
 
-## Requirements
-
-git-changelog requires Python 3.6 or above.
-
-<details>
-<summary>To install Python 3.6, I recommend using <a href="https://github.com/pyenv/pyenv"><code>pyenv</code></a>.</summary>
-
-```bash
-# install pyenv
-git clone https://github.com/pyenv/pyenv ~/.pyenv
-
-# setup pyenv (you should also put these three lines in .bashrc or similar)
-export PATH="${HOME}/.pyenv/bin:${PATH}"
-export PYENV_ROOT="${HOME}/.pyenv"
-eval "$(pyenv init -)"
-
-# install Python 3.6
-pyenv install 3.6.12
-
-# make it available globally
-pyenv global system 3.6.12
-```
-</details>
-
 ## Installation
 
 With `pip`:
 ```bash
-python3.6 -m pip install git-changelog
+pip install git-changelog
 ```
 
 With [`pipx`](https://github.com/pipxproject/pipx):
 ```bash
-python3.6 -m pip install --user pipx
-
-pipx install --python python3.6 git-changelog
+python3.7 -m pip install --user pipx
+pipx install git-changelog
 ```
 
 ## Usage (command-line)

config/flake8.ini

@@ -10,6 +10,8 @@ ignore =
     D105
     # multi-line docstring summary should start at the first line
     D212
+    # does not support Parameters sections
+    D417
     # whitespace before ':' (incompatible with Black)
     E203
     # redundant with E0602 (undefined variable)

config/mypy.ini

@@ -1,9 +1,5 @@
 [mypy]
 ignore_missing_imports = true
 exclude = tests/fixtures/
-
-[mypy-toml]
-ignore_missing_imports = true
-
-[mypy-pkg_resources]
-ignore_missing_imports = true
+warn_unused_ignores = true
+show_error_codes = true

docs/credits.md

@@ -0,0 +1,3 @@
+```python exec="yes"
+--8<-- "scripts/gen_credits.py"
+```

docs/gen_ref_nav.py

@@ -6,18 +6,25 @@
 
 nav = mkdocs_gen_files.Nav()
 
-for path in sorted(Path("src").glob("**/*.py")):
+for path in sorted(Path("src").rglob("*.py")):
     module_path = path.relative_to("src").with_suffix("")
-    doc_path = path.relative_to("src", "git_changelog").with_suffix(".md")
+    doc_path = path.relative_to("src").with_suffix(".md")
     full_doc_path = Path("reference", doc_path)
 
-    parts = list(module_path.parts)
-    parts[-1] = f"{parts[-1]}.py"
-    nav[parts] = doc_path
+    parts = tuple(module_path.parts)
+
+    if parts[-1] == "__init__":
+        parts = parts[:-1]
+        doc_path = doc_path.with_name("index.md")
+        full_doc_path = full_doc_path.with_name("index.md")
+    elif parts[-1] == "__main__":
+        continue
+
+    nav[parts] = doc_path.as_posix()
 
     with mkdocs_gen_files.open(full_doc_path, "w") as fd:
-        ident = ".".join(module_path.parts)
-        print("::: " + ident, file=fd)
+        ident = ".".join(parts)
+        fd.write(f"::: {ident}")
 
     mkdocs_gen_files.set_edit_path(full_doc_path, path)