Skip to content
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

Jump to bottom

Fix GH workflow so docs deploy on new releases #245

Merged
merged 2 commits into from
Apr 27, 2024
Merged

Fix GH workflow so docs deploy on new releases #245

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d9f6df5
Fix GH workflow so docs deploy on new releases
mcmire Apr 27, 2024
f9060a7
Merge branch 'main' into fix-workflow-file-for-docs
mcmire Apr 27, 2024
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
24 changes: 15 additions & 9 deletions .github/workflows/super_diff.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,25 +120,25 @@ jobs:
run: |
set -x

if [[ "$IS_NEW_RELEASE" == "true" ]]; then
if [[ "$GITHUB_EVENT_NAME" == "push" && "$GITHUB_REF_NAME" == "main" && "$IS_NEW_RELEASE" == "true" ]]; then
DOCSITE_RELEASE_VERSION="$RELEASE_VERSION"
DOCSITE_DESTINATION_PATH="releases/$RELEASE_VERSION"
HAS_CHANGES_TO_DOCS="true"
HAS_DOCS_CHANGES_TO_RELEASE="true"
else
DOCSITE_RELEASE_VERSION="$COMMIT_ID"
DOCSITE_DESTINATION_PATH="branches/$BRANCH_NAME/$COMMIT_ID"
# Check if there any changes to docs/
if git diff --quiet --merge-base "origin/$GITHUB_BASE_REF" -- docs; then
HAS_CHANGES_TO_DOCS="false"
HAS_DOCS_CHANGES_TO_RELEASE="false"
else
HAS_CHANGES_TO_DOCS="true"
HAS_DOCS_CHANGES_TO_RELEASE="true"
fi
fi

{
echo "DOCSITE_RELEASE_VERSION=$DOCSITE_RELEASE_VERSION"
echo "DOCSITE_DESTINATION_PATH=$DOCSITE_DESTINATION_PATH"
echo "HAS_CHANGES_TO_DOCS=$HAS_CHANGES_TO_DOCS"
echo "HAS_DOCS_CHANGES_TO_RELEASE=$HAS_DOCS_CHANGES_TO_RELEASE"
} >> "$GITHUB_OUTPUT"
env:
IS_NEW_RELEASE: ${{ needs.collect-release-info.outputs.IS_NEW_RELEASE }}
Expand All @@ -148,15 +148,15 @@ jobs:
outputs:
DOCSITE_RELEASE_VERSION: ${{ steps.command.outputs.DOCSITE_RELEASE_VERSION }}
DOCSITE_DESTINATION_PATH: ${{ steps.command.outputs.DOCSITE_DESTINATION_PATH }}
HAS_CHANGES_TO_DOCS: ${{ steps.command.outputs.HAS_CHANGES_TO_DOCS }}
HAS_DOCS_CHANGES_TO_RELEASE: ${{ steps.command.outputs.HAS_DOCS_CHANGES_TO_RELEASE }}

build-docsite:
runs-on: ubuntu-latest
needs:
- analyze
- collect-release-info
- collect-docsite-release-info
if: ${{ github.event_name == 'pull_request' && ((needs.collect-release-info.outputs.IS_NEW_RELEASE == 'false' && needs.collect-docsite-release-info.outputs.HAS_CHANGES_TO_DOCS == 'true') || (needs.collect-release-info.outputs.IS_NEW_RELEASE == 'true' && github.event.merged)) }}
if: ${{ needs.collect-docsite-release-info.outputs.HAS_DOCS_CHANGES_TO_RELEASE == 'true' }}
steps:
- uses: actions/checkout@v4
- name: Install poetry
Expand All @@ -178,6 +178,8 @@ jobs:
needs:
- collect-release-info
- collect-docsite-release-info
# This already runs if there are docs changes to publish, so we don't need
# to check that here
- build-docsite
steps:
- uses: actions/checkout@v4
Expand All @@ -191,25 +193,28 @@ jobs:
- name: Update redirect in index (for a release)
if: ${{ needs.collect-release-info.outputs.IS_NEW_RELEASE == 'true' }}
run: |
url="https://${GITHUB_REPOSITORY_OWNER}.github.io/${GITHUB_REPOSITORY#"${GITHUB_REPOSITORY_OWNER}/"}/releases/${DOCSITE_RELEASE_VERSION}"
cat <<-EOT > index.html
<!DOCTYPE html>
<html>
<head>
<title>SuperDiff Documentation</title>
<meta http-equiv="refresh" content="0; url='https://mcmire.github.com/super_diff/releases/${RELEASE_VERSION}'" />
<meta http-equiv="refresh" content="0; url='${url}'" />
</head>
<body>
<p>
This page has moved to a different URL.
Please click
<a href="https://mcmire.github.com/super_diff/releases/${RELEASE_VERSION}">
<a href="${url}">
this link
</a>
if you are not redirected.
</p>
</body>
</html>
EOT
env:
DOCSITE_RELEASE_VERSION: ${{ needs.collect-docsite-release-info.outputs.DOCSITE_RELEASE_VERSION }}
- name: Copy site/ to ${{ needs.collect-docsite-release-info.outputs.DOCSITE_DESTINATION_PATH }}
run: |
mkdir -p "$(dirname "$DOCSITE_DESTINATION_PATH")"
Expand All @@ -226,6 +231,7 @@ jobs:
env:
DOCSITE_DESTINATION_PATH: ${{ needs.collect-docsite-release-info.outputs.DOCSITE_DESTINATION_PATH }}
- name: Announce publishing of docsite as a comment on the PR
if: ${{ github.event_name == 'pull_request' }}
run: |
gh pr comment "$PULL_REQUEST_NUMBER" --body ":book: A new version of the docsite has been published at: <https://mcmire.github.io/super_diff/$DOCSITE_DESTINATION_PATH>"
env:
Expand Down