diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml index 4ef2eb3..e22f1cb 100644 --- a/.github/workflows/deploy-docs.yml +++ b/.github/workflows/deploy-docs.yml @@ -1,19 +1,51 @@ name: Deploy Docs + on: + # Runs on pushes targeting the default branch push: - branches: [ main ] + 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: + id-token: write + contents: read + pages: 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: + # Single deploy job since we're just deploying deploy: + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 - with: - fetch-depth: 0 + - name: Checkout + uses: actions/checkout@v4 + - name: Setup Pages + uses: actions/configure-pages@v4 - name: Set up Python 3 uses: actions/setup-python@v3 + - name: Install dependencies run: python -m pip install -r docs/requirements.txt - - name: Build Docs - run: mkdocs gh-deploy --force \ No newline at end of file + - name: Build Site + run: mkdocs build + + - name: Upload artifact + uses: actions/upload-pages-artifact@v3 + with: + # Upload entire repository + path: './site' + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4 \ No newline at end of file diff --git a/.gitignore b/.gitignore index e05ae9e..bbecc97 100644 --- a/.gitignore +++ b/.gitignore @@ -2,12 +2,10 @@ logs *.log npm-debug.log* -yarn-debug.log* -yarn-error.log* -lerna-debug.log* .pnpm-debug.log* # Compiled outputs +site/* build/* bin/*