From ff29fd5334c41b5d9830fcfbb8d928a8d04428cf Mon Sep 17 00:00:00 2001 From: Dasun Pubudumal Date: Fri, 16 Aug 2024 10:28:36 +0100 Subject: [PATCH] chore: Add GitHub Pages deployment workflow --- .github/workflows/generate_pages.yml | 42 ++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 .github/workflows/generate_pages.yml diff --git a/.github/workflows/generate_pages.yml b/.github/workflows/generate_pages.yml new file mode 100644 index 0000000000..dbc13294ce --- /dev/null +++ b/.github/workflows/generate_pages.yml @@ -0,0 +1,42 @@ +name: Deploy Yard to GitHub Pages + +on: + push: + branches: + - 'master' + - 'github-pages-doc' + workflow_dispatch: + +permissions: + pages: write # Allow writing to the GitHub Pages + id-token: write # Allow OIDC token to be issued + +jobs: + build: + runs-on: ubuntu-latest + + steps: + - name: Checkout repository + uses: actions/checkout@v3 + + - name: Set up Ruby + uses: ruby/setup-ruby@v1 + with: + bundler-cache: true + + - name: Generate Yard documentation + run: | + bundle exec yard doc + + - name: Upload artifact to GitHub Pages + uses: actions/upload-pages-artifact@v3 + with: + path: doc # Path to the folder containing the Yard documentation (default is 'doc') + + deploy: + runs-on: ubuntu-latest + needs: build # The deploy job will only run if the build job is successful + + steps: + - name: Deploy to GitHub Pages + uses: actions/deploy-pages@v4 \ No newline at end of file