Skip to content

Commit

Permalink
UPD: Docs changelog auto-generate
Browse files Browse the repository at this point in the history
  • Loading branch information
nandyalu committed Dec 12, 2024
1 parent d21864d commit 965aaa7
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 16 deletions.
4 changes: 2 additions & 2 deletions docs/help/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ markdown
::github-release-changelog <org>\<repo>
base_indent: 2
token: !ENV GITHUB_TOKEN
github_api_url: <url>
release_template: <jinja2 str>
<!-- github_api_url: <url> -->
<!-- release_template: <jinja2 str> -->
match: '[0-9+].[0-9+].[0-9]+'
autoprocess: true
28 changes: 14 additions & 14 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -50,19 +50,19 @@ plugins:
- search
- git-revision-date-localized
# - swagger-ui-tag
- mkdocs_github_changelog:
token: !ENV GITHUB_TOKEN
# Github token (needs repo scope for private repos, and may be worth setting for public repos due to rate limiting).
github_api_url: <url>
# URL for github api endpoint if not standard github.com (This is not tested on github enterprise server).
release_template: <jinja2 str>
# Jinja2 template string to override the default.
match: '[0-9+].[0-9+].[0-9]+'
# Regex string for matching the rleease name.
autoprocess: True
# Autoprocess the body for user and issue/pull request links
enabled: True
# Enable or disable the plugin.
# - mkdocs_github_changelog:
# token: !ENV GITHUB_TOKEN
# # Github token (needs repo scope for private repos, and may be worth setting for public repos due to rate limiting).
# # github_api_url: <url>
# # URL for github api endpoint if not standard github.com (This is not tested on github enterprise server).
# # release_template: <jinja2 str>
# # Jinja2 template string to override the default.
# match: '[0-9+].[0-9+].[0-9]+'
# # Regex string for matching the rleease name.
# autoprocess: True
# # Autoprocess the body for user and issue/pull request links
# enabled: True
# # Enable or disable the plugin.
markdown_extensions:
- attr_list
- admonition
Expand Down Expand Up @@ -102,7 +102,7 @@ nav:
- Common: help/common.md
- FAQ: help/faq.md
- Release Notes: help/release-notes.md
- Changelog: help/changelog.md
# - Changelog: help/changelog.md
- Docker Builder: help/docker-builder/builder.html
# extra_javascript:
# - js/docker-builder.js

0 comments on commit 965aaa7

Please sign in to comment.