From c55c8d803dcde74771ac2430af36ca335926fe5b Mon Sep 17 00:00:00 2001 From: "Erik C. Thauvin" Date: Tue, 21 Mar 2023 14:34:01 -0700 Subject: [PATCH] Added Javadoc pages workflow --- .github/workflows/pages.yml | 65 +++++++++++++++++++++++++++++++++++++ 1 file changed, 65 insertions(+) create mode 100644 .github/workflows/pages.yml diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml new file mode 100644 index 0000000..5d4dfa6 --- /dev/null +++ b/.github/workflows/pages.yml @@ -0,0 +1,65 @@ +name: javadocs-pages + +on: + # Runs on pushes targeting the default branch + push: + branches: ["main"] + + # 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 one concurrent deployment +concurrency: + group: "pages" + cancel-in-progress: true + +jobs: + # Single deploy job since we're just deploying + deploy: + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + + runs-on: ubuntu-latest + + env: + GRADLE_OPTS: "-Dorg.gradle.jvmargs=-XX:MaxMetaspaceSize=512m" + + steps: + - name: Checkout source repository + uses: actions/checkout@v3 + with: + fetch-depth: 0 + + - name: Set up JDK 19 + uses: actions/setup-java@v3 + with: + distribution: 'temurin' + java-version: 19 + + - name: Grant execute permission for gradlew + run: chmod +x gradlew + + - name: Build Javadocs + uses: gradle/gradle-build-action@v2 + with: + arguments: clean javadoc + + - name: Setup Pages + uses: actions/configure-pages@v3 + + - name: Upload artifact + uses: actions/upload-pages-artifact@v1 + with: + # Upload generated Javadocs repository + path: 'lib/build/docs/javadoc/' + + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v1 \ No newline at end of file