Skip to content
This repository was archived by the owner on Apr 26, 2024. It is now read-only.

Deploy a documentation version for each new Synapse release #10198

Merged
merged 5 commits into from
Jun 18, 2021
Merged

Deploy a documentation version for each new Synapse release #10198

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
54080ad
Additionally deploy to a folder named after current Synapse version
anoadragon453 May 27, 2021
699daa6
Changelog
anoadragon453 Jun 17, 2021
b5ee31b
Properly prevent rc versions from causing a deploy
anoadragon453 Jun 18, 2021
379f008
Actually put some text in the changelog
anoadragon453 Jun 18, 2021
b4682dd
turns out it's not bash-specific
anoadragon453 Jun 18, 2021
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
14 changes: 10 additions & 4 deletions .github/workflows/docs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,15 @@ jobs:
- name: Get the current Synapse version
id: vars
# The $GITHUB_REF value for a branch looks like `refs/heads/release-v1.2`. We do some
# bash magic to remove the "refs/heads/release-v" bit from this, to end up with
# "1.2" - our major/minor version number.
run: echo ::set-output name=synapse-version::${GITHUB_REF#refs/heads/release-v}
# bash magic to remove the "refs/heads/release-v" bit from this, to end up with "1.2",
# our major/minor version number, and set this to a var called `branch-version`.
#
# We then use some python to get Synapse's full version string, which may look
# like "1.2.3rc4". We set this to a var called `synapse-version`. We use this
# to determine if this release is still an RC, and if so block deployment.
run: |
echo ::set-output name=branch-version::${GITHUB_REF#refs/heads/release-v}
echo ::set-output name=synapse-version::`python3 -c 'import synapse; print(synapse.__version__)'`

# Deploy to the version-specific directory
- name: Deploy release-specific documentation
Expand All @@ -55,4 +61,4 @@ jobs:
keep_files: true
publish_dir: ./book
# The resulting documentation will end up in a directory named `vX.Y`.
destination_dir: ./v${{ steps.vars.outputs.synapse-version }}
destination_dir: ./v${{ steps.vars.outputs.branch-version }}