From bc5fa38669b63a0c45c3ba0e34a923f67d012fbc Mon Sep 17 00:00:00 2001 From: halorrr Date: Tue, 23 Jan 2024 21:11:28 -0500 Subject: [PATCH] add github pages publish flow --- .../workflows/build_and_public_yard_docs.yml | 47 +++++++++++++++++++ 1 file changed, 47 insertions(+) create mode 100644 .github/workflows/build_and_public_yard_docs.yml diff --git a/.github/workflows/build_and_public_yard_docs.yml b/.github/workflows/build_and_public_yard_docs.yml new file mode 100644 index 0000000..4d3fd34 --- /dev/null +++ b/.github/workflows/build_and_public_yard_docs.yml @@ -0,0 +1,47 @@ +name: Build and Publish Yard Docs + +on: + push: + branches: [ main ] + workflow_dispatch: + +permissions: + contents: read + pages: write + id-token: write + +concurrency: + group: "pages" + cancel-in-progress: true + +jobs: + build: + name: Build and Publish Yard Docs + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v4 + + - name: Set up Ruby + uses: ruby/setup-ruby@v1.165.1 + with: + ruby-version: 3.3.0 + bundler-cache: true + + - name: Install YARD + run: gem install yard + + - name: Generate docs + run: yard docs + + - name: Setup Github Pages + uses: actions/configure-pages@v4 + + - name: Upload Artifact + uses: actions/upload-pages-artifact@v3 + with: + path: "doc" + + - name: Publish to Github Pages + id: deployment + uses: actions/deploy-pages@v4