From acb57315624132674da9e72f8d00e883c7ca5245 Mon Sep 17 00:00:00 2001 From: Techassi Date: Wed, 29 Jan 2025 16:57:15 +0100 Subject: [PATCH 1/3] ci: Publish crate docs on Github Pages --- .github/workflows/publish-docs.yml | 52 ++++++++++++++++++++++++++++++ 1 file changed, 52 insertions(+) create mode 100644 .github/workflows/publish-docs.yml diff --git a/.github/workflows/publish-docs.yml b/.github/workflows/publish-docs.yml new file mode 100644 index 000000000..e16f83eaa --- /dev/null +++ b/.github/workflows/publish-docs.yml @@ -0,0 +1,52 @@ +--- +name: Publish Crate Docs + +# Once the `preview` input is available, this can also run on PR when docs are +# changed. + +on: + push: + branches: + - main + paths: + - .github/workflows/publish-docs.yml + - crates/** + +env: + RUST_TOOLCHAIN_VERSION: "1.82.0" + +jobs: + build-docs: + runs-on: ubuntu-latest + steps: + - name: Checkout Repository + uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 + + - uses: dtolnay/rust-toolchain@master + with: + toolchain: ${{ env.RUST_TOOLCHAIN_VERSION }} + + - name: Build Crate Docs + run: cargo doc --no-deps --all-features + + - name: Add Redirect + run: echo '' > target/doc/index.html + + - name: Upload Documentation Artifacts + uses: actions/upload-pages-artifact@56afc609e74202658d3ffba0e8f6dda462b719fa #v3.0.1 + with: + path: target/doc + + publish-docs: + runs-on: ubuntu-latest + needs: build-docs + permissions: + pages: write + id-token: write + environment: + name: github-pages + url: ${{ steps.deploy.outputs.page_url }} + steps: + - name: Deploy to Github Pages + id: deploy + uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e # v4.0.5 From 734b6c41ad9f2da8d09a913b531f9d051f880752 Mon Sep 17 00:00:00 2001 From: Techassi Date: Wed, 29 Jan 2025 17:03:29 +0100 Subject: [PATCH 2/3] temp(ci): Trigger workflow on PR for testing --- .github/workflows/publish-docs.yml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.github/workflows/publish-docs.yml b/.github/workflows/publish-docs.yml index e16f83eaa..ff67d5817 100644 --- a/.github/workflows/publish-docs.yml +++ b/.github/workflows/publish-docs.yml @@ -5,6 +5,10 @@ name: Publish Crate Docs # changed. on: + pull_request: + paths: + - .github/workflows/publish-docs.yml + - crates/** push: branches: - main From af9c9812d23293ee01fee6c0fc470363b57a6245 Mon Sep 17 00:00:00 2001 From: Techassi Date: Wed, 29 Jan 2025 17:26:42 +0100 Subject: [PATCH 3/3] Revert "temp(ci): Trigger workflow on PR for testing" This reverts commit 734b6c41ad9f2da8d09a913b531f9d051f880752. --- .github/workflows/publish-docs.yml | 4 ---- 1 file changed, 4 deletions(-) diff --git a/.github/workflows/publish-docs.yml b/.github/workflows/publish-docs.yml index ff67d5817..e16f83eaa 100644 --- a/.github/workflows/publish-docs.yml +++ b/.github/workflows/publish-docs.yml @@ -5,10 +5,6 @@ name: Publish Crate Docs # changed. on: - pull_request: - paths: - - .github/workflows/publish-docs.yml - - crates/** push: branches: - main