From 08511146b5faf1309f05ee3fd4e9a01043fc7157 Mon Sep 17 00:00:00 2001 From: Benoit Viguier Date: Mon, 26 Aug 2024 22:58:50 +0200 Subject: [PATCH] Use Just-the-docs template --- .github/workflows/jekyll-gh-pages.yml | 40 ++++++++++++++++++++------- 1 file changed, 30 insertions(+), 10 deletions(-) diff --git a/.github/workflows/jekyll-gh-pages.yml b/.github/workflows/jekyll-gh-pages.yml index 909d330..e3d9e42 100644 --- a/.github/workflows/jekyll-gh-pages.yml +++ b/.github/workflows/jekyll-gh-pages.yml @@ -1,10 +1,17 @@ +# This workflow uses actions that are not certified by GitHub. +# They are provided by a third-party and are governed by +# separate terms of service, privacy policy, and support +# documentation. + # Sample workflow for building and deploying a Jekyll site to GitHub Pages -name: Deploy Jekyll with GitHub Pages dependencies preinstalled +name: Deploy Jekyll site to Pages on: - # Runs on pushes targeting the default branch push: branches: ["main"] + paths: + - "docs/**" + - ".github/workflows/jekyll-gh-pages.yml" # Allows you to run this workflow manually from the Actions tab workflow_dispatch: @@ -15,28 +22,41 @@ permissions: 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. +# Allow one concurrent deployment concurrency: group: "pages" - cancel-in-progress: false + cancel-in-progress: true jobs: # Build job build: runs-on: ubuntu-latest + defaults: + run: + working-directory: docs steps: - name: Checkout uses: actions/checkout@v4 + - name: Setup Ruby + uses: ruby/setup-ruby@v1 + with: + ruby-version: '3.3' # Not needed with a .ruby-version file + bundler-cache: true # runs 'bundle install' and caches installed gems automatically + cache-version: 0 # Increment this number if you need to re-download cached gems + working-directory: '${{ github.workspace }}/docs' - name: Setup Pages + id: pages uses: actions/configure-pages@v5 - name: Build with Jekyll - uses: actions/jekyll-build-pages@v1 - with: - source: ./docs - destination: ./_site + # Outputs to the './_site' directory by default + run: bundle exec jekyll build --baseurl "${{ steps.pages.outputs.base_path }}" + env: + JEKYLL_ENV: production - name: Upload artifact + # Automatically uploads an artifact from the './_site' directory by default uses: actions/upload-pages-artifact@v3 + with: + path: "docs/_site/" # Deployment job deploy: @@ -48,4 +68,4 @@ jobs: steps: - name: Deploy to GitHub Pages id: deployment - uses: actions/deploy-pages@v4 + uses: actions/deploy-pages@v4 \ No newline at end of file