diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index 74a326c..2945b1f 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -1,52 +1,58 @@ -name: deploy +name: deploy-book on: # Trigger the deploy on push to main branch push: branches: - main - schedule: - # jupyter-book is updated regularly, let's run this deployment every month in case something fails - # - # https://pubs.opengroup.org/onlinepubs/9699919799/utilities/crontab.html#tag_20_25_07 - # https://crontab.guru/every-month - # Run cron job every month - - cron: '0 0 1 * *' - -jobs: - # This job deploys the example book - deploy-example-book: - runs-on: ${{ matrix.os }} - strategy: - matrix: - os: [ubuntu-latest] - python-version: [3.8] + +env: + BASE_URL: /${{ github.event.repository.name }} + +# 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-book: + runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 - # Install CC - - name: Set up Python ${{ matrix.python-version }} - uses: actions/setup-python@v1 - with: - python-version: ${{ matrix.python-version }} - - name: Install dependencies - run: | - pip install -r requirements.txt - # Use default CC - - name: Cookiecutter no GHA - run: | - cookiecutter . --no-input include_ci=no - # Install requirements.txt - - name: Install requirements - run: | - pip install -r my_book/requirements.txt - # Build the example book - - name: Build book - run: | - jupyter-book build my_book/my_book/ - # Deploy html to gh-pages - - name: GitHub Pages action - uses: peaceiris/actions-gh-pages@v3.6.1 - with: - github_token: ${{ secrets.GITHUB_TOKEN }} - publish_dir: my_book/my_book/_build/html - publish_branch: gh-pages + - uses: actions/checkout@v3 + + # Install dependencies + - name: Set up Python 3.11 + uses: actions/setup-python@v4 + with: + python-version: 3.11 + + - name: Install dependencies + run: | + pip install -r requirements.txt + + # Build the book + - name: Build the book + run: | + jupyter-book build . + + # Setup for GitHub Pages deployment + - name: Setup Pages + uses: actions/configure-pages@v3 + + # Upload the book's HTML as an artifact (optional) + - name: Upload artifact + uses: actions/upload-pages-artifact@v1 + with: + path: "./_build/html" + + # Deploy the book's HTML to GitHub Pages + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v2