Skip to content

Commit

Permalink
Fixing docs publish (#2)
Browse files Browse the repository at this point in the history
  • Loading branch information
djpugh authored Dec 27, 2023
1 parent a44520c commit 27c890f
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 1 deletion.
9 changes: 9 additions & 0 deletions .github/workflows/pipeline.yaml
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
2 changes: 1 addition & 1 deletion docs/source/index.md
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 Down

0 comments on commit 27c890f

Please sign in to comment.