Skip to content

Fix release workflow not publishing latest tags for docs #277

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix release workflow not publishing latest tags for docs #277

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 7 additions & 4 deletions .github/workflows/release_workflow.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ on:
release:
types: [published]

workflow_dispatch:
Copy link
Collaborator Author

@tomvothecoder tomvothecoder Jun 21, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This line allows us to manually run workflows. We need to add this because the release workflow currently only triggers when releasing new versions. However, we want to run it manually to fix the v1.3.0 docs.


jobs:
publish-docs:
runs-on: ubuntu-latest
Expand Down Expand Up @@ -57,10 +59,11 @@ jobs:
# Add `index.html` to point to the `main` branch automatically.
printf '<meta http-equiv="refresh" content="0; url=./_build/html/main/index.html" />' > index.html

# Only replace `main` docs with latest changes. Docs for tags should be untouched.
rm -rf _build/html/main
mkdir -p _build/html/main
cp -r ../docs/_build/html/main _build/html
# Replace main docs to populate dropdown with latest tags
rm -r _build/html/main

# Only copy docs for main and current tag
cp -r -n ../docs/_build/html _build/

# Configure git using GitHub Actions credentials.
git config --local user.email "41898282+github-actions[bot]@users.noreply.github.com"
Expand Down