Release 24.9.0 (#118) #461
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
| name: docs-build | |
| on: | |
| push: | |
| branches: [ main ] | |
| tags: | |
| - v* | |
| workflow_dispatch: | |
| env: | |
| REGISTRY: ghcr.io | |
| IMAGE_NAME: ${{ github.repository }} | |
| TAG: 0.3.0 | |
| GH_TOKEN: ${{ github.token }} | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }} | |
| cancel-in-progress: true | |
| jobs: | |
| dockerfile-changed: | |
| runs-on: ubuntu-latest | |
| permissions: | |
| contents: read | |
| packages: read | |
| outputs: | |
| changed: ${{ steps.change.outputs.changed }} | |
| image: ${{ steps.change.outputs.image }} | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Log in to Container Registry | |
| uses: docker/login-action@v3 | |
| with: | |
| registry: ${{ env.REGISTRY }} | |
| username: ${{ github.actor }} | |
| password: ${{ secrets.GITHUB_TOKEN }} | |
| - name: Detect change | |
| id: change | |
| shell: bash | |
| run: | | |
| export COMMIT_SHORT_SHA="${GITHUB_SHA:0:8}" | |
| if ! docker manifest inspect "${REGISTRY}/${IMAGE_NAME,,}:${TAG}" 2>&1 > /dev/null ; then | |
| echo "image not found...${REGISTRY}/${IMAGE_NAME,,}:${TAG}" | |
| export NEEDS_IMAGE=true | |
| fi | |
| def_branch=$(gh api "repos/${GITHUB_REPOSITORY}" -q '.default_branch') | |
| git fetch origin "${def_branch}" | |
| files=$(git diff --name-only "${GITHUB_SHA}" FETCH_HEAD | tr '\n' ' ') | |
| echo "${files}" | |
| if echo "${files}" | grep -q "deps/\|Dockerfile\|repo.toml"; then export NEEDS_IMAGE=true ; fi | |
| if [[ "${NEEDS_IMAGE}" ]]; then | |
| echo "changed=true" >> "$GITHUB_OUTPUT" | |
| if [[ "${{ github.event_name }}" == 'pull_request' ]]; then | |
| echo "image=${REGISTRY}/${IMAGE_NAME,,}:${COMMIT_SHORT_SHA}" >> "$GITHUB_OUTPUT" | |
| else | |
| echo "image=${REGISTRY}/${IMAGE_NAME,,}:${TAG}" >> "$GITHUB_OUTPUT" | |
| fi | |
| else | |
| echo "changed=false" >> "$GITHUB_OUTPUT" | |
| echo "image=${REGISTRY}/${IMAGE_NAME,,}:${TAG}" >> "$GITHUB_OUTPUT" | |
| fi | |
| build-and-push-image: | |
| needs: dockerfile-changed | |
| if: needs.dockerfile-changed.outputs.changed == 'true' | |
| runs-on: ubuntu-latest | |
| permissions: | |
| contents: read | |
| packages: write | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Set up Docker Buildx | |
| uses: docker/setup-buildx-action@v3 | |
| - name: Log in to Container Registry | |
| uses: docker/login-action@v3 | |
| with: | |
| registry: ${{ env.REGISTRY }} | |
| username: ${{ github.actor }} | |
| password: ${{ secrets.GITHUB_TOKEN }} | |
| - name: Build and push | |
| uses: docker/build-push-action@v6 | |
| with: | |
| context: . | |
| file: docker/Dockerfile | |
| push: true | |
| tags: ${{ needs.dockerfile-changed.outputs.image }} | |
| build-docs: | |
| needs: [dockerfile-changed, build-and-push-image] | |
| container: | |
| image: ${{ needs.dockerfile-changed.outputs.image }} | |
| if: ${{ always() }} | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Build docs | |
| run: | | |
| ./repo docs | |
| - name: Delete unnecessary files | |
| run: | | |
| find _build -name .doctrees -prune -exec rm -rf {} \; | |
| find _build -name .buildinfo -exec rm {} \; | |
| - name: Copy review page | |
| run: | | |
| mv _build/docs/review/latest/* _build/docs | |
| rm -rf _build/docs/review _build/docs/tmp _build/docs/sphinx_warnings.txt | |
| - name: Upload HTML | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: html-build-artifact | |
| path: _build/docs | |
| if-no-files-found: error | |
| retention-days: 1 | |
| - name: Store PR information | |
| if: github.event_name == 'pull_request' | |
| run: | | |
| mkdir ./pr | |
| echo ${{ github.event.number }} > ./pr/pr.txt | |
| echo ${{ github.event.pull_request.merged }} > ./pr/merged.txt | |
| echo ${{ github.event.action }} > ./pr/action.txt | |
| - name: Upload PR information | |
| if: ${{ github.event_name == 'pull_request' }} | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: pr | |
| path: pr/ | |
| store-html: | |
| needs: [ build-docs ] | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| ref: "gh-pages" | |
| - name: Initialize Git configuration | |
| run: | | |
| git config user.name docs-build | |
| git config user.email [email protected] | |
| - name: Download artifacts | |
| uses: actions/download-artifact@v4 | |
| with: | |
| name: html-build-artifact | |
| - name: Copy HTML directories | |
| run: | | |
| ls -asl | |
| for i in `ls -d *` | |
| do | |
| echo "Git adding ${i}" | |
| git add "${i}" | |
| done | |
| - name: Check or create dot-no-jekyll file | |
| run: | | |
| if [ -f ".nojekyll" ]; then | |
| echo "The dot-no-jekyll file already exists." | |
| exit 0 | |
| fi | |
| touch .nojekyll | |
| git add .nojekyll | |
| - name: Check or create redirect page | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| run: | | |
| resp=$(grep 'http-equiv="refresh"' index.html 2>/dev/null) || true | |
| if [ -n "${resp}" ]; then | |
| echo "The redirect file already exists." | |
| exit 0 | |
| fi | |
| # If any of these commands fail, fail the build. | |
| def_branch=$(gh api "repos/${GITHUB_REPOSITORY}" --jq ".default_branch") | |
| html_url=$(gh api "repos/${GITHUB_REPOSITORY}/pages" --jq ".html_url") | |
| # Beware ugly quotation mark avoidance in the foll lines. | |
| echo '<!DOCTYPE html>' > index.html | |
| echo '<html>' >> index.html | |
| echo ' <head>' >> index.html | |
| echo ' <title>Redirect to documentation</title>' >> index.html | |
| echo ' <meta charset="utf-8">' >> index.html | |
| echo ' <meta http=equiv="refresh" content="3; URL='${html_url}${def_branch}'/index.html">' >> index.html | |
| echo ' <link rel="canonical" href="'${html_url}${def_branch}'/index.html">' >> index.html | |
| echo ' <script language="javascript">' >> index.html | |
| echo ' function redirect() {' >> index.html | |
| echo ' window.location.assign("'${html_url}${def_branch}'/index.html")' >> index.html | |
| echo ' }' >> index.html | |
| echo ' </script>' >> index.html | |
| echo ' </head>' >> index.html | |
| echo ' <body onload="redirect()">' >> index.html | |
| echo ' <p>Please follow the link to the <a href="'${html_url}${def_branch}'/index.html">' >> index.html | |
| echo ${def_branch}'</a> branch documentation.</p>' >> index.html | |
| echo ' </body>' >> index.html | |
| echo '</html>' >> index.html | |
| git add index.html | |
| - name: Commit changes to the GitHub Pages branch | |
| run: | | |
| git status | |
| if git commit -m 'Pushing changes to GitHub Pages.'; then | |
| git push -f | |
| else | |
| echo "Nothing changed." | |
| fi |