Compare commits
1 Commits
7542b17a74
...
53d0418e96
| Author | SHA1 | Date | |
|---|---|---|---|
|
53d0418e96
|
18
.github/workflows/release.yml
vendored
18
.github/workflows/release.yml
vendored
@@ -115,20 +115,6 @@ jobs:
|
|||||||
cd "${RUNNER_TEMP}/mkdocs_out/site_offline/"
|
cd "${RUNNER_TEMP}/mkdocs_out/site_offline/"
|
||||||
zip -r "${GITHUB_REF_NAME}.zip" ./${GITHUB_REF_NAME}
|
zip -r "${GITHUB_REF_NAME}.zip" ./${GITHUB_REF_NAME}
|
||||||
|
|
||||||
- name: Prepare release notes
|
|
||||||
run: |
|
|
||||||
set -euo pipefail
|
|
||||||
|
|
||||||
RELEASE_NOTES="${RUNNER_TEMP}/release-notes.md"
|
|
||||||
|
|
||||||
if [[ "${GITHUB_REF_NAME}" == draft* || "${GITHUB_REF_NAME}" == rc* ]]; then
|
|
||||||
printf 'Prerelease.\n\n' > "${RELEASE_NOTES}"
|
|
||||||
else
|
|
||||||
: > "${RELEASE_NOTES}"
|
|
||||||
fi
|
|
||||||
|
|
||||||
cat docs/summary-of-changes.md >> "${RELEASE_NOTES}"
|
|
||||||
|
|
||||||
- name: Publish prerelease
|
- name: Publish prerelease
|
||||||
if: startsWith(github.ref_name, 'rc') || startsWith(github.ref_name, 'draft')
|
if: startsWith(github.ref_name, 'rc') || startsWith(github.ref_name, 'draft')
|
||||||
uses: softprops/action-gh-release@v2
|
uses: softprops/action-gh-release@v2
|
||||||
@@ -136,7 +122,8 @@ jobs:
|
|||||||
prerelease: true
|
prerelease: true
|
||||||
name: ${{ github.ref_name }}
|
name: ${{ github.ref_name }}
|
||||||
tag_name: ${{ github.ref_name }}
|
tag_name: ${{ github.ref_name }}
|
||||||
body_path: ${{ runner.temp }}/release-notes.md
|
body: |
|
||||||
|
Prerelease.
|
||||||
files: |
|
files: |
|
||||||
${{ runner.temp }}/mkdocs_out/site_offline/${{ github.ref_name }}.zip
|
${{ runner.temp }}/mkdocs_out/site_offline/${{ github.ref_name }}.zip
|
||||||
${{ runner.temp }}/pandoc/${{ github.ref_name }}-${{ env.SHORT_SHA }}.docx
|
${{ runner.temp }}/pandoc/${{ github.ref_name }}-${{ env.SHORT_SHA }}.docx
|
||||||
@@ -147,7 +134,6 @@ jobs:
|
|||||||
with:
|
with:
|
||||||
name: ${{ github.ref_name }}
|
name: ${{ github.ref_name }}
|
||||||
tag_name: ${{ github.ref_name }}
|
tag_name: ${{ github.ref_name }}
|
||||||
body_path: ${{ runner.temp }}/release-notes.md
|
|
||||||
files: |
|
files: |
|
||||||
${{ runner.temp }}/mkdocs_out/site_offline/${{ github.ref_name }}.zip
|
${{ runner.temp }}/mkdocs_out/site_offline/${{ github.ref_name }}.zip
|
||||||
|
|
||||||
|
|||||||
@@ -69,8 +69,6 @@ It builds both the normal site and an offline site package, then publishes based
|
|||||||
- `rc*`: creates a GitHub prerelease, attaches the offline zip and generated `.docx`, and deploys the preview site to the `gh-pages` branch under `/rc/`
|
- `rc*`: creates a GitHub prerelease, attaches the offline zip and generated `.docx`, and deploys the preview site to the `gh-pages` branch under `/rc/`
|
||||||
- `v*`: creates a GitHub release, attaches the offline zip, and deploys the release site to the root of the `gh-pages` branch
|
- `v*`: creates a GitHub release, attaches the offline zip, and deploys the release site to the root of the `gh-pages` branch
|
||||||
|
|
||||||
The GitHub release description is generated from `docs/summary-of-changes.md`. Draft and release-candidate prereleases prepend a short prerelease note before that summary.
|
|
||||||
|
|
||||||
In all cases, the release workflow uses the same MkDocs configuration in `mkdocs/mkdocs.yml`, with strict mode controlled by the `MKDOCS_STRICT` GitHub Actions variable.
|
In all cases, the release workflow uses the same MkDocs configuration in `mkdocs/mkdocs.yml`, with strict mode controlled by the `MKDOCS_STRICT` GitHub Actions variable.
|
||||||
|
|
||||||
## Project History
|
## Project History
|
||||||
|
|||||||
Reference in New Issue
Block a user