diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml index b3851d91b9a6bb78297b61b3cf33cf730b61521d..27527daa1c032e5ec598b00366e54440864d9192 100644 --- a/.github/workflows/deploy-docs.yml +++ b/.github/workflows/deploy-docs.yml @@ -1,40 +1,70 @@ - +# Workflow to build and deploy the static sites generated with jupyter-book to GitHub Pages name: deploy-docs on: push: - branches: - - 'main' + branches: ['main'] + + workflow_dispatch: + +# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages +permissions: + contents: read + pages: write + id-token: write + +# Allow one concurrent deployment +concurrency: + group: "pages" + cancel-in-progress: true + + jobs: - deploy-book: + build-docs: + runs-on: ubuntu-latest + steps: + - name: Checkout + - uses: actions/checkout@v3 + + # Install dependencies + - name: Set up Python 3.7 + uses: actions/setup-python@v1 + with: + python-version: 3.7 + + - name: Install dependencies + run: | + pip install -U jupyter-book + + # Build the docs + - name: Build the docs + run: | + jupyter-book clean docs + jupyter-book build docs + - name Upload artifact + uses: actions/upload-pages-artifact@v1 + with: + path: './docs/_build/html' + #- name: Create cname file + # uses: finnp/create-file-action@master + # env: + # FILE_NAME: "./docs/_build/html/CNAME" + # FILE_DATA: "unhide-docs.helmholtz-metadaten.de" + + # Push the book's HTML to github-pages + #- name: GitHub Pages action + # uses: peaceiris/actions-gh-pages@v3.6.1 + # with: + # github_token: ${{ secrets.GITHUB_TOKEN }} + # publish_dir: ./docs/_build/html + deploy: + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} runs-on: ubuntu-latest + needs: build-docs steps: - - uses: actions/checkout@v2 - - # Install dependencies - - name: Set up Python 3.7 - uses: actions/setup-python@v1 - with: - python-version: 3.7 - - - name: Install dependencies - run: | - pip install -U jupyter-book - # Build the book - - name: Build the docs - run: | - jupyter-book clean docs - jupyter-book build docs - - name: Create cname file - uses: finnp/create-file-action@master - env: - FILE_NAME: "./docs/_build/html/CNAME" - FILE_DATA: "unhide-docs.helmholtz-metadaten.de" - - # Push the book's HTML to github-pages - - name: GitHub Pages action - uses: peaceiris/actions-gh-pages@v3.6.1 - with: - github_token: ${{ secrets.GITHUB_TOKEN }} - publish_dir: ./docs/_build/html + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v1