Skip to content

Fix/docs publish #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
djpugh wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Fix/docs publish #12

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b181cd9
Fixing docs publish
djpugh Dec 27, 2023
cddfc8e
Fixing docs typo
djpugh Dec 27, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions .github/workflows/pipeline.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -479,6 +479,15 @@ jobs:
else
echo "tag_exists=false" >> $GITHUB_OUTPUT
fi
- shell: bash
name: Install tomli
run: |
pip install tomli
- shell: python
name: Install test dependencies
run: |
import subprocess, tomli
subprocess.check_call(['pip', 'install']+tomli.load(open('pyproject.toml', 'rb'))['project']['optional-dependencies']['dev-docs'])
- name: Deploy
run: |
git config user.name github-actions
Expand Down
4 changes: 2 additions & 2 deletions docs/source/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ mkdocs extension to autogenerate changelogs from github releases.
An ``mkdocs`` equivalent to [sphinx_github_changelog](https://github.com/ewjoachim/sphinx-github-changelog).

## Why?
Easy releasing is key for rapid and robust software development. We use tag based releases, but want an easy way to generate the changelog automatically, enter [release drafter](https://github.com/release-drafter/release-drafter) and GitHub Releases.
Easy releasing is key for rapid and robust software development. We use tag based releases, but want an easy way to generate the changelog automatically, on the Github side, we use [release drafter](https://github.com/release-drafter/release-drafter) and GitHub Releases.

[Release drafter](https://github.com/release-drafter/release-drafter) allows you to generate draft releases from your pull requests, and then use the release to generate the tag automatically, and include the release changelog in the release body. Assuming you've got good pull release hygiene, you can cut a new release by editing the draft GitHub Release and then pressing "Publish Release".

Expand All @@ -28,7 +28,7 @@ plugins:
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.
# Regex string for matching the release name.
autoprocess: True
# Autoprocess the body for user and issue/pull request links
enabled: True
Expand Down