setup-okapi-framework

This GitHub Action will download, install, and cache the Okapi Framework.

You will need to manage the Java version setup in the JAVA_HOME environment variable on your runner. The windows-2022 runner uses Java 8 as its default and Okapi requires Java 11. An example is provided below showing you how to change it. You can lookup the Java versions available and the default set at the respective actions/runner-images readme.

Usage

See action.yml

uses: jimmymcpeter/setup-okapi-framework@v1
with:
  version: '1.47.0'

Ubuntu

runs-on: ubuntu-22.04
steps:
  - name: Setup Okapi Framework
    uses: jimmymcpeter/setup-okapi-framework@v1
    with:
      version: '1.47.0'

  - name: Use Okapi Framework
    run: |
      tikal.sh -x *.htm

Windows

runs-on: windows-2022
steps:
  - name: Setup Okapi Framework
    uses: jimmymcpeter/setup-okapi-framework@v1
    with:
      version: '1.47.0'

  - name: Setup Java 11
    # windows-2022 uses Java 8 as the default, and Okapi requires Java 11
    # Using `echo "JAVA_HOME=$Env:JAVA_HOME_11_X64" >> $Env:GITHUB_ENV` will not work
    uses: actions/setup-java@c5195efecf7bdfc987ee8bae7a71cb8b11521c00 # v4.7.1
    with:
      java-version: '11'
      distribution: 'temurin'

  - name: Use Okapi Framework
    run: |
      tikal.bat -x *.htm