docs: link to all "available" versions of the docs #1210
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: Build and deploy documentation | |
| on: | |
| push: | |
| # Runs on pushes targeting the release branches | |
| branches: | |
| - main | |
| - nixos-24.05 | |
| # Allows you to run this workflow manually from the Actions tab | |
| workflow_dispatch: | |
| # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| # Allow one concurrent deployment | |
| concurrency: | |
| group: "pages" | |
| cancel-in-progress: true | |
| jobs: | |
| deploy: | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| runs-on: ubuntu-latest | |
| timeout-minutes: 40 | |
| env: | |
| repo: ${{ github.repository }} | |
| repoName: ${{ github.event.repository.name }} | |
| out: docs-build | |
| steps: | |
| - name: Install nix | |
| uses: cachix/install-nix-action@v26 | |
| with: | |
| nix_path: nixpkgs=channel:nixos-unstable | |
| - name: Configure cachix | |
| uses: cachix/cachix-action@v15 | |
| with: | |
| name: nix-community | |
| authToken: "${{ secrets.CACHIX_AUTH_TOKEN }}" | |
| - name: Build docs | |
| run: | | |
| set -ex | |
| # A list of all doc versions to be built, | |
| # (Written to versions.json) | |
| echo ' | |
| [ | |
| { | |
| "branch": "main", | |
| "nixpkgsBranch": "nixos-unstable" | |
| }, | |
| { | |
| "branch": "nixos-24.05", | |
| "nixpkgsBranch": "nixos-24.05", | |
| "subPath": "stable" | |
| // TODO: consider having 24.05 instead of stable? | |
| } | |
| ] | |
| ' | sed 's/^ *\/\/.*//' | jq \ | |
| --arg repoName "$repoName" \ | |
| 'map( | |
| . | |
| # Ensure subPath is a string | |
| | .subPath = (.subPath // "") | |
| # Construct baseHref from $repoName and .subPath | |
| | .baseHref = ( | |
| .subPath | |
| | if . == "" then "" else "/\(.)" end | |
| | $repoName + . | |
| | "/\(.)/" | |
| ) | |
| )' > versions.json | |
| # 1: branch | |
| # 2: baseHref | |
| # 3: install dir | |
| build() { | |
| flakeref="github:${repo}${1:+/$1}" | |
| baseHref="$2" | |
| installDir="${out}${3:+/$3}" | |
| # Build docs for the given flake ref, overriding the relevant derivation args | |
| nix build --impure \ | |
| --argstr flakeref "$flakeref" \ | |
| --argstr baseHref "$baseHref" \ | |
| --arg-from-file versionsJson versions.json \ | |
| --expr ' | |
| { | |
| flakeref, | |
| baseHref, | |
| versionsJson, | |
| system ? builtins.currentSystem, | |
| }: | |
| let | |
| flake = builtins.getFlake flakeref; | |
| packages = flake.outputs.packages.${system}; | |
| in | |
| packages.docs.override { | |
| inherit baseHref; | |
| availableVersions = builtins.fromJSON versionsJson; | |
| } | |
| ' | |
| # Copy the result to the install dir | |
| mkdir -p "$installDir" | |
| cp -r result/share/doc/* "$installDir" | |
| } | |
| # For each version of the docs... | |
| jq -c '.[]' versions.json | | |
| while IFS=$"\n" read -r entry; do | |
| branch=$(echo "$entry" | jq -r '.branch') | |
| baseHref=$(echo "$entry" | jq -r '.baseHref') | |
| installDir=$(echo "$entry" | jq -r '.subPath') | |
| # Build this version of the docs | |
| build "$branch" "$baseHref" "$installDir" | |
| done | |
| - name: Upload artifact | |
| uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: "docs-build" | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v4 |