From 6e837bd0df6789d67ecfa1c4e04374837600e554 Mon Sep 17 00:00:00 2001 From: Maycon Amaro <131882788+mayconamaroCW@users.noreply.github.com> Date: Mon, 26 Feb 2024 14:50:19 -0300 Subject: [PATCH] docs: add deploy action (#270) * docs: add deploy action * chore: add redirect index page * chore: add concurrency * perf: remove test when bulding docs --- .github/workflows/docs-release.yml | 64 ++++++++++++++++++++++++++++++ justfile | 1 - 2 files changed, 64 insertions(+), 1 deletion(-) create mode 100644 .github/workflows/docs-release.yml diff --git a/.github/workflows/docs-release.yml b/.github/workflows/docs-release.yml new file mode 100644 index 000000000..ccfa6fbaa --- /dev/null +++ b/.github/workflows/docs-release.yml @@ -0,0 +1,64 @@ +name: Documentation Deploy + +on: + push: + branches: + - main + workflow_dispatch: + +permissions: + contents: read + pages: write + id-token: write + +concurrency: + group: ${{ github.workflow }}-${{ github.ref || github.run_id }} + cancel-in-progress: true + +jobs: + # Builds the documentation and upload as an artifact + docs-build: + runs-on: ubuntu-latest + + steps: + - name: Set up Rust Nightly and Rust Docs + run: | + curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y --default-toolchain nightly + rustup component add rust-docs + + - name: Set up Just + uses: extractions/setup-just@v1 + + - name: Checkout code + uses: actions/checkout@v3 + + - name: Generate docs + run: | + just doc + echo "" >> target/doc/index.html + chmod -c -R +rX target/doc/ + + - name: Upload docs artifact + uses: actions/upload-pages-artifact@v1 + with: + path: 'target/doc' + + # Uploads the documentation to GitHub Pages + docs-release: + runs-on: ubuntu-latest + needs: docs-build + + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + + steps: + - name: Download GH Pages artifact + uses: actions/download-artifact@v3 + + - name: Configure GH Pages + uses: actions/configure-pages@v3 + + - name: Deploy to GH Pages + id: deployment + uses: actions/deploy-pages@v2 \ No newline at end of file diff --git a/justfile b/justfile index fc5ed1fba..8aba88e94 100644 --- a/justfile +++ b/justfile @@ -58,7 +58,6 @@ clean: # Stratus: Build documentation doc: - @just test-doc cargo +nightly doc --no-deps # Stratus: Lint and format code