Merge pull request #120 from eshwen/esh-auto-changelog

Auto-generated changelog
eshwen · Oct 26, 2023 · d49f7c0 · d49f7c0
2 parents 29ef99e + d1a48e2
commit d49f7c0
Show file tree

Hide file tree

Showing 8 changed files with 55 additions and 2 deletions.
diff --git a/.github/workflows/api-docs.yml b/.github/workflows/api-docs.yml
@@ -16,5 +16,6 @@ jobs:
 
       - name: Build docs
         run: |
-          git fetch
+          git fetch --unshallow
+          git-changelog -p github -o CHANGELOG.md
           mkdocs gh-deploy
diff --git a/.gitignore b/.gitignore
@@ -136,3 +136,6 @@ dmypy.json
 
 # Ruff
 .ruff_cache/
+
+# Auto-generated changelog
+CHANGELOG.md
diff --git a/docs/changelog.md b/docs/changelog.md
@@ -0,0 +1 @@
+--8<-- "CHANGELOG.md"
diff --git a/docs/documentation.md b/docs/documentation.md
@@ -8,14 +8,18 @@ See [linting and formatting](linting-formatting.md) for more information.
 API documentation is built with MkDocs using the Material theme. To build a static copy locally, run
 
 ```shell
+git-changelog -p github -o CHANGELOG.md  # (1)
 mkdocs build
 ```
 
+1. This generates the changelog.
+
 Then open the homepage HTML file under `site/index.html`.
 
 Or, to render it live on a local server, run
 
 ```shell
+git-changelog -p github -o CHANGELOG.md
 mkdocs serve
 ```
 

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -13,6 +13,7 @@ nav:
       - General Python Tips: general-python-tips.md
   - Getting Started: getting-started.md
   - Code Reference: reference/
+  - Changelog: changelog.md
 
 plugins:
   - mkdocstrings:

diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -78,6 +78,7 @@ termynal = "*"
 mkdocs-gen-files = "*"
 mkdocs-literate-nav = "*"
 mkdocs-section-index = "*"
+git-changelog = "*"
 
 [tool.black]
 target-version = ['py310']

diff --git a/requirements-dev.txt b/requirements-dev.txt
@@ -1,4 +1,5 @@
 anyio==3.7.1 ; python_version >= "3.10" and python_version < "3.11"
+appdirs==1.4.4 ; python_version >= "3.10" and python_version < "3.11"
 appnope==0.1.3 ; python_version >= "3.10" and python_version < "3.11" and (sys_platform == "darwin" or platform_system == "Darwin")
 argon2-cffi-bindings==21.2.0 ; python_version >= "3.10" and python_version < "3.11"
 argon2-cffi==23.1.0 ; python_version >= "3.10" and python_version < "3.11"
@@ -31,6 +32,7 @@ fastjsonschema==2.18.0 ; python_version >= "3.10" and python_version < "3.11"
 filelock==3.12.2 ; python_version >= "3.10" and python_version < "3.11"
 fqdn==1.5.1 ; python_version >= "3.10" and python_version < "3.11"
 ghp-import==2.1.0 ; python_version >= "3.10" and python_version < "3.11"
+git-changelog==2.3.2 ; python_version >= "3.10" and python_version < "3.11"
 griffe==0.35.0 ; python_version >= "3.10" and python_version < "3.11"
 identify==2.5.27 ; python_version >= "3.10" and python_version < "3.11"
 idna==3.4 ; python_version >= "3.10" and python_version < "3.11"
@@ -128,6 +130,7 @@ rfc3339-validator==0.1.4 ; python_version >= "3.10" and python_version < "3.11"
 rfc3986-validator==0.1.1 ; python_version >= "3.10" and python_version < "3.11"
 rpds-py==0.9.2 ; python_version >= "3.10" and python_version < "3.11"
 ruff==0.0.285 ; python_version >= "3.10" and python_version < "3.11"
+semver==3.0.2 ; python_version >= "3.10" and python_version < "3.11"
 send2trash==1.8.2 ; python_version >= "3.10" and python_version < "3.11"
 setuptools==68.1.2 ; python_version >= "3.10" and python_version < "3.11"
 six==1.16.0 ; python_version >= "3.10" and python_version < "3.11"