-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
GitHub release action: publish HTML docs in an archive
- Loading branch information
Showing
2 changed files
with
39 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -71,11 +71,43 @@ jobs: | |
asset_name: ${{ env.ASSET }} | ||
asset_content_type: application/octet-stream | ||
|
||
docs-build-deploy: | ||
strategy: | ||
matrix: | ||
os: [ubuntu-latest] | ||
runs-on: ${{ matrix.os }} | ||
docs-release-archive: | ||
runs-on: ubuntu-latest | ||
permissions: | ||
contents: write | ||
|
||
steps: | ||
- name: Install packages (Ubuntu) | ||
run: | | ||
sudo apt-get update | ||
sudo apt-get install -y --no-install-recommends xz-utils liblz4-tool musl-tools | ||
- uses: actions/checkout@v3 | ||
- uses: actions/setup-python@v4 | ||
with: | ||
python-version: 3.11 | ||
- name: Install poetry | ||
uses: abatilo/actions-poetry@v2 | ||
with: | ||
poetry-version: latest | ||
- name: Compile docs and zip them up | ||
run: | | ||
poetry install | ||
poetry run -- mkdocs build --no-directory-urls | ||
archive="jj-${{ github.event.release.tag_name }}-docs-html.tar.gz" | ||
tar czf "$archive" -C "rendered-docs" . | ||
echo "ASSET=$archive" >> $GITHUB_ENV | ||
- name: Upload release archive | ||
uses: actions/upload-release-asset@e8f9f06c4b078e705bd2ea027f0926603fc9b4d5 | ||
env: | ||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
with: | ||
upload_url: ${{ github.event.release.upload_url }} | ||
asset_path: ${{ env.ASSET }} | ||
asset_name: ${{ env.ASSET }} | ||
asset_content_type: application/octet-stream | ||
|
||
docs-deploy-website-latest-release: | ||
runs-on: ubuntu-latest | ||
permissions: | ||
contents: write | ||
|
||
|
@@ -89,7 +121,7 @@ jobs: | |
uses: abatilo/actions-poetry@v2 | ||
with: | ||
poetry-version: latest | ||
- name: Install dependencies, compile and deploy docs | ||
- name: Install dependencies, compile and deploy docs to the "latest release" section of the website | ||
run: | | ||
git config user.name jj-docs-bot | ||
git config user.email [email protected] | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -12,6 +12,7 @@ extra: | |
version: | ||
provider: mike | ||
plugins: | ||
- offline | ||
- search | ||
- redirects: | ||
redirect_maps: | ||
|