From 5b585f3f8f56a58fd6b3dfcfdf7cf44f89fad11a Mon Sep 17 00:00:00 2001 From: xavi Date: Mon, 12 Feb 2024 09:03:15 -0600 Subject: [PATCH] Update docs workflow --- .github/workflows/crystal.yml | 20 -------------- .github/workflows/docs.yml | 50 +++++++++++++++++++++++++++++++++++ 2 files changed, 50 insertions(+), 20 deletions(-) delete mode 100644 .github/workflows/crystal.yml create mode 100644 .github/workflows/docs.yml diff --git a/.github/workflows/crystal.yml b/.github/workflows/crystal.yml deleted file mode 100644 index f249ae0..0000000 --- a/.github/workflows/crystal.yml +++ /dev/null @@ -1,20 +0,0 @@ -name: Crystal CI - -on: - push: - branches: [ "docs" ] - pull_request: - branches: [ "docs" ] - -jobs: - build: - - runs-on: ubuntu-latest - - container: - image: crystallang/crystal - - steps: - - uses: actions/checkout@v3 - - name: Generate docs - run: crystal docs diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 0000000..95a20ba --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,50 @@ +name: Crystal Docs Generation + +on: + push: + branches: [ "docs" ] + pull_request: + branches: [ "docs" ] + # 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: + build: + + runs-on: ubuntu-latest + + container: + image: crystallang/crystal + + steps: + - uses: actions/checkout@v3 + - name: Generate docs + run: crystal docs + - name: Move docs to _site + run: mv docs/ _site/ + - name: Upload artifact + uses: actions/upload-pages-artifact@v3 + +# Deployment job +deploy: + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-latest + needs: build + steps: + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4