Update README.md #100
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| # Sample workflow for building and deploying a Jekyll site to GitHub Pages | ||
| name: Deploy Jekyll with GitHub Pages dependencies preinstalled | ||
| uses: actions/[email protected] | ||
| with: | ||
| # The Java version to set up. Takes a whole or semver Java version. See examples of supported syntax in README file | ||
| java-version: # optional | ||
| # The path to the `.java-version` file. See examples of supported syntax in README file | ||
| java-version-file: # optional | ||
| # Java distribution. See the list of supported distributions in README file | ||
| distribution: | ||
| # The package type (jdk, jre, jdk+fx, jre+fx) | ||
| java-package: # optional, default is jdk | ||
| # The architecture of the package (defaults to the action runner's architecture) | ||
| architecture: # optional | ||
| # Path to where the compressed JDK is located | ||
| jdkFile: # optional | ||
| # Set this option if you want the action to check for the latest available version that satisfies the version spec | ||
| check-latest: # optional | ||
| # ID of the distributionManagement repository in the pom.xml file. Default is `github` | ||
| server-id: # optional, default is github | ||
| # Environment variable name for the username for authentication to the Apache Maven repository. Default is $GITHUB_ACTOR | ||
| server-username: # optional, default is GITHUB_ACTOR | ||
| # Environment variable name for password or token for authentication to the Apache Maven repository. Default is $GITHUB_TOKEN | ||
| server-password: # optional, default is GITHUB_TOKEN | ||
| # Path to where the settings.xml file will be written. Default is ~/.m2. | ||
| settings-path: # optional | ||
| # Overwrite the settings.xml file if it exists. Default is "true". | ||
| overwrite-settings: # optional, default is true | ||
| # GPG private key to import. Default is empty string. | ||
| gpg-private-key: # optional | ||
| # Environment variable name for the GPG private key passphrase. Default is $GPG_PASSPHRASE. | ||
| gpg-passphrase: # optional | ||
| # Name of the build platform to cache dependencies. It can be "maven", "gradle" or "sbt". | ||
| cache: # optional | ||
| # The path to a dependency file: pom.xml, build.gradle, build.sbt, etc. This option can be used with the `cache` option. If this option is omitted, the action searches for the dependency file in the entire repository. This option supports wildcards and a list of file names for caching multiple dependencies. | ||
| cache-dependency-path: # optional | ||
| # Workaround to pass job status to post job step. This variable is not intended for manual setting | ||
| job-status: # optional, default is ${{ job.status }} | ||
| # The token used to authenticate when fetching version manifests hosted on github.com, such as for the Microsoft Build of OpenJDK. When running this action on github.com, the default value is sufficient. When running on GHES, you can pass a personal access token for github.com if you are experiencing rate limiting. | ||
| token: # optional, default is ${{ github.server_url == 'https://github.com' && github.token || '' }} | ||
| # Name of Maven Toolchain ID if the default name of "${distribution}_${java-version}" is not wanted. See examples of supported syntax in Advanced Usage file | ||
| mvn-toolchain-id: # optional | ||
| # Name of Maven Toolchain Vendor if the default name of "${distribution}" is not wanted. See examples of supported syntax in Advanced Usage file | ||
| mvn-toolchain-vendor: # optional | ||
| 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 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 job | ||
| build: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Checkout | ||
| uses: actions/checkout@v4 | ||
| - name: Setup Pages | ||
| uses: actions/configure-pages@v4 | ||
| - name: Build with Jekyll | ||
| uses: actions/jekyll-build-pages@v1 | ||
| with: | ||
| source: ./ | ||
| destination: ./_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 | ||
