Allow publishing of release notes on the site

testcontainers · Jul 20, 2024 · d116871 · d116871
1 parent 8d0b5a7
commit d116871
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 0 deletions.
diff --git a/.devcontainer/requirements.txt b/.devcontainer/requirements.txt
@@ -2,6 +2,7 @@ Markdown==3.5
 MarkupSafe==2.1.3
 mergedeep==1.3.4
 mkdocs==1.6.0
+mkdocstrings==0.25.1
 mkdocs-autorefs==0.5.0
 mkdocs-macros-plugin==1.0.5
 mkdocs-material==9.5.28
@@ -12,6 +13,7 @@ mkdocs-extra-sass-plugin==0.1.0
 mkdocs-render-swagger-plugin==0.1.1
 mkdocs-same-dir==0.1.3
 mkdocs-pdf==0.1.1
+mkdocs_github_changelog==0.1.0
 livereload==2.6.3
 lxml==4.9.3
 click==8.1.7

diff --git a/docs/changelog.md b/docs/changelog.md
@@ -0,0 +1,4 @@
+# Release Notes
+
+## ::github-release-changelog testcontainers/testcontainers-native
+
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -36,6 +36,7 @@ nav:
       - WireMock: modules/wiremock/README.md
   - Contributing: CONTRIBUTING.md
   - Resources:
+    - Release Notes: docs/changelog.md
     - Roadmap: ROADMAP.md
     - Support: docs/SUPPORT.md
     - Security: docs/SECURITY.md
@@ -52,6 +53,18 @@ plugins:
   - same-dir
   - redirects:
       redirect_maps:
+  - mkdocstrings:
+      default_handler: python
+      enable_inventory: true
+      handlers:
+        python:
+          paths: [src]
+  - mkdocs_github_changelog:
+      token: !ENV GITHUB_TOKEN
+      release_template: <jinja2 str>
+      match: 'v[0-9+].[0-9+].[0-9]+'
+      autoprocess: true
+      enabled: true
 
 # Markdown
 markdown_extensions:
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,4 @@
		# Release Notes

		## ::github-release-changelog testcontainers/testcontainers-native