From 988dd2f37924961dd32014b212291c92dde54e58 Mon Sep 17 00:00:00 2001 From: Nicolas Villanueva Date: Tue, 22 Aug 2023 07:49:25 +0100 Subject: [PATCH] docs: Adds rust docs GitHub workflow. (#80) --- .github/workflows/docs.yaml | 44 +++++++++++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) create mode 100644 .github/workflows/docs.yaml diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml new file mode 100644 index 00000000..e2fd8e0b --- /dev/null +++ b/.github/workflows/docs.yaml @@ -0,0 +1,44 @@ +# Simple workflow for deploying static content to GitHub Pages +name: Deploy static content to Pages + +on: + push: + branches: ["main"] + + # 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 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: + deploy: + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v3 + - name: Setup Pages + uses: actions/configure-pages@v3 + - name: Generate rust docs + run: | + echo "Generating docs..." + cargo doc --no-deps + - name: Upload artifact + uses: actions/upload-pages-artifact@v2 + with: + path: 'target/doc' + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v2 \ No newline at end of file