From 27c890fac984e72d9655afed799faa6394c31ef4 Mon Sep 17 00:00:00 2001 From: David J Pugh <6003255+djpugh@users.noreply.github.com> Date: Wed, 27 Dec 2023 09:22:10 +0000 Subject: [PATCH] Fixing docs publish (#2) --- .github/workflows/pipeline.yaml | 9 +++++++++ docs/source/index.md | 2 +- 2 files changed, 10 insertions(+), 1 deletion(-) diff --git a/.github/workflows/pipeline.yaml b/.github/workflows/pipeline.yaml index a27ee26..9d2199d 100644 --- a/.github/workflows/pipeline.yaml +++ b/.github/workflows/pipeline.yaml @@ -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 diff --git a/docs/source/index.md b/docs/source/index.md index 82b708b..fbef7b7 100644 --- a/docs/source/index.md +++ b/docs/source/index.md @@ -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".