setup-java VS github-pages-deploy-action

name: Java Build and Test With Gradle on: [push, pull_request, workflow_dispatch] jobs: build: runs-on: ubuntu-latest permissions: contents: read steps: - name: Checkout uses: actions/checkout@v4.2.2 with: fetch-depth: 0 - name: Set up JDK 23 uses: actions/setup-java@v4.5.0 #https://github.com/actions/setup-java with: java-version: '23' distribution: 'oracle' - name: Install GitVersion 6.0.5 for Gradle run: | wget -q -O gitversion.tar.gz https://github.com/GitTools/GitVersion/releases/download/6.0.5/gitversion-linux-x64-6.0.5.tar.gz mkdir gitversion_extracted tar -xzf gitversion.tar.gz -C gitversion_extracted ls -R gitversion_extracted sudo mv gitversion_extracted/gitversion /usr/local/bin/gitversion sudo chmod +x /usr/local/bin/gitversion - name: Setup Gradle 8.11.1 uses: gradle/actions/setup-gradle@v4 #https://github.com/gradle/actions/blob/main/docs/setup-gradle.md#build-with-a-specific-gradle-version with: gradle-version: '8.11.1' - name: Build with Gradle 8.11.1 run: gradle build --scan --warning-mode all dependency-submission: # See: https://github.com/gradle/actions/blob/main/dependency-submission/README.md runs-on: ubuntu-latest permissions: contents: write steps: - name: Checkout uses: actions/checkout@v4.2.2 - name: Set up JDK 23 uses: actions/setup-java@v4.5.0 with: java-version: '23' distribution: 'oracle' - name: Setup Gradle 8.11.1 uses: gradle/actions/setup-gradle@v4 with: gradle-version: '8.11.1' - name: Setup Gradle Wrapper run: gradle wrapper - name: Generate and submit dependency graph uses: gradle/actions/dependency-submission@v4

Then, we have two important initial steps to define. The first one is an official GitHub Action used to check-out a repository so a workflow can access it. The second one it's pretty more complex but, briefly, downloads and set up a requested version of Java.

The most popular ones are Node.js, Python, Java JDK, Go, .Net Core SDK.

Finally, note that the v2 of setup-java GitHub Action limits the possible JDK distributions to four options. If you need to use one that is not listed, use foojayio/setup-java instead to configure any distribution.

See https://github.com/actions/setup-java for more configuration regarding distribution, version and caching.

Why can't Oracle just integrate with https://github.com/actions/setup-java like everyone else?

Next up we'll need to add a step to compile our production ready build. For this we can add two new steps, one which configures our Node version to ensure it matches our application, followed by another that runs the necessary commands with npm. Depending on how your application is built you may need to add another step between these to install any sort of required environments such as Python or Java.

Set up the JDK with the actions/setup-java GitHub Action.

Deploy to GitHub Pages git.ts - Read to help you improve your own deployment script.

The interesting part is towards the bottom where we build the frontend code and make use of the github-pages-deploy-action step to automatically make a new commit with the compiled frontend code to a gh-pages branch.

Finally, will do the deploy on github pages using the scripts from JamesIves/github-pages-deploy-action, and create a branch gh-pages with the code from apps/web/build.

- Deploy to GitHub Pages using GitHub Actions

For Storybook deploy, we will use github-pages-deploy-action

If you've built a site that can be rendered statically, then you can probably set up a GitHub Pages deploy via GitHub Actions (since Pages supports only Jekyll by default, you need this for any other static site generator). But if you have a server component, then you'll need to host it some other way.

Around three years ago I created the github-pages-deploy-action project as my first real venture into the world of open source. I built this action so I could make continued updates to a blog while being away from my work laptop. The community response has been fantastic and I'm very happy with how it has evolved over the years as a result. I even had the opportunity to be interviewed by GitHub for my involvement back in 2020 which you can read here.

This action is a composite action using shell scripts for installing necessary tools and preparing docs and makes use of JamesIves/github-pages-deploy-action for deploying the docs to a GitHub Pages branch.