From ec80f45b93ac47e8fbf86e7ee6d929aacfc3519d Mon Sep 17 00:00:00 2001 From: strawberry Date: Mon, 18 Mar 2024 01:30:40 -0400 Subject: [PATCH] move docs/gh pages into separate workflow Signed-off-by: strawberry --- .github/workflows/ci.yml | 46 +---------- .github/workflows/documentation.yml | 118 ++++++++++++++++++++++++++++ 2 files changed, 120 insertions(+), 44 deletions(-) create mode 100644 .github/workflows/documentation.yml diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index d8e0e6e68..6296fc789 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -1,4 +1,4 @@ -name: CI, Artifacts, and Documentation +name: CI and Artifacts on: pull_request: @@ -23,22 +23,10 @@ env: permissions: packages: write contents: read - pages: write - id-token: write - -# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. -# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. -concurrency: - group: "pages" - cancel-in-progress: false jobs: ci: - name: CI, Artifacts, and Documentation - - environment: - name: github-pages - url: ${{ steps.deployment.outputs.page_url }} + name: CI and Artifacts runs-on: ubuntu-latest @@ -46,10 +34,6 @@ jobs: - name: Sync repository uses: actions/checkout@v4 - - name: Setup GitHub Pages - if: github.event_name != 'pull_request' - uses: actions/configure-pages@v4 - - name: Install Nix (with flakes and nix-command enabled) uses: cachix/install-nix-action@v26 with: @@ -177,32 +161,6 @@ jobs: compression-level: 0 - - name: Build documentation (book) - run: | - ./bin/nix-build-and-cache .#book - cp -r --dereference result public - - - name: Upload generated documentation (book) as normal artifact - uses: actions/upload-artifact@v4 - with: - name: public - path: public - if-no-files-found: error - # don't compress again - compression-level: 0 - - - name: Upload generated documentation (book) as GitHub Pages artifact - if: github.event_name != 'pull_request' - uses: actions/upload-pages-artifact@v3 - with: - path: public - - - name: Deploy to GitHub Pages - if: github.event_name != 'pull_request' - id: deployment - uses: actions/deploy-pages@v4 - - - name: Extract metadata for Dockerhub env: REGISTRY: registry.hub.docker.com diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml new file mode 100644 index 000000000..3f6f1755e --- /dev/null +++ b/.github/workflows/documentation.yml @@ -0,0 +1,118 @@ +name: Documentation and GitHub Pages + +on: + pull_request: + push: + branches: + - main + - "2024-03-16" + + # Allows you to run this workflow manually from the Actions tab + workflow_dispatch: + +env: + # Required to make some things output color + TERM: ansi + # Publishing to my nix binary cache + ATTIC_TOKEN: ${{ secrets.ATTIC_TOKEN }} + # Custom nix binary cache if fork is being used + ATTIC_ENDPOINT: ${{ vars.ATTIC_ENDPOINT }} + ATTIC_PUBLIC_KEY: ${{ vars.ATTIC_PUBLIC_KEY }} + +# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. +# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. +concurrency: + group: "pages" + cancel-in-progress: false + +jobs: + docs: + name: Documentation and GitHub Pages + + runs-on: ubuntu-latest + + permissions: + pages: write + id-token: write + + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + + steps: + - name: Sync repository + uses: actions/checkout@v4 + + - name: Setup GitHub Pages + if: github.event_name != 'pull_request' + uses: actions/configure-pages@v4 + + - name: Install Nix (with flakes and nix-command enabled) + uses: cachix/install-nix-action@v26 + with: + nix_path: nixpkgs=channel:nixos-unstable + + # Add `nix-community`, Crane, upstream Conduit, and conduwuit binary caches + extra_nix_config: | + experimental-features = nix-command flakes + extra-substituters = https://nix-community.cachix.org + extra-trusted-public-keys = nix-community.cachix.org-1:mB9FSh9qf2dCimDSUo8Zy7bkq5CX+/rkCWyvRCYg3Fs= + extra-substituters = https://crane.cachix.org + extra-trusted-public-keys = crane.cachix.org-1:8Scfpmn9w+hGdXH/Q9tTLiYAE/2dnJYRJP7kl80GuRk= + extra-substituters = https://nix.computer.surgery/conduit + extra-trusted-public-keys = conduit:ZGAf6P6LhNvnoJJ3Me3PRg7tlLSrPxcQ2RiE5LIppjo= + extra-substituters = https://attic.kennel.juneis.dog/conduit + extra-trusted-public-keys = conduit:Isq8FGyEC6FOXH6nD+BOeAA+bKp6X6UIbupSlGEPuOg= + extra-substituters = https://attic.kennel.juneis.dog/conduwuit + extra-trusted-public-keys = conduwuit:lYPVh7o1hLu1idH4Xt2QHaRa49WRGSAqzcfFd94aOTw= + + - name: Add alternative Nix binary caches if specified + if: ${{ (env.ATTIC_ENDPOINT != '') && (env.ATTIC_PUBLIC_KEY != '') }} + run: | + echo "extra-substituters = ${{ env.ATTIC_ENDPOINT }}" >> /etc/nix/nix.conf + echo "extra-trusted-public-keys = ${{ env.ATTIC_PUBLIC_KEY }}" >> /etc/nix/nix.conf + + - name: Pop/push Magic Nix Cache + uses: DeterminateSystems/magic-nix-cache-action@main + + - name: Configure `nix-direnv` + run: | + echo 'source $HOME/.nix-profile/share/nix-direnv/direnvrc' > "$HOME/.direnvrc" + + - name: Install `direnv` and `nix-direnv` + run: nix-env -f "" -iA direnv -iA nix-direnv + + # Do this to shorten the logs for the real CI step + - name: Populate `/nix/store` + run: nix develop --command true + + - name: Allow direnv + run: direnv allow + + - name: Cache x86_64 inputs for devShell + run: | + ./bin/nix-build-and-cache .#devShells.x86_64-linux.default.inputDerivation + + - name: Build documentation (book) + run: | + ./bin/nix-build-and-cache .#book + cp -r --dereference result public + - name: Upload generated documentation (book) as normal artifact + uses: actions/upload-artifact@v4 + with: + name: public + path: public + if-no-files-found: error + # don't compress again + compression-level: 0 + + - name: Upload generated documentation (book) as GitHub Pages artifact + if: github.event_name != 'pull_request' + uses: actions/upload-pages-artifact@v3 + with: + path: public + + - name: Deploy to GitHub Pages + if: github.event_name != 'pull_request' + id: deployment + uses: actions/deploy-pages@v4