ubc GitHub Action

This action downloads and installs a specific version of the ubc CLI tool, adds it to the PATH, and executes a specified ubc command. Checkout the official documentation for a list of supported commands.

It supports caching the ubc binary to speed up workflow runs.

Inputs

The following inputs can be used to configure the action:

Input	Description	Default	Required
args	Arguments to pass to the ubc command. If provided, ubc will be invoked immediately.	''	No
version	The version of the ubc CLI to install. Use latest for the latest version.	0.19.1	No
license-key	The ubCode license key. Recommended to be passed via secrets.	''	No
license-user	The ubCode license user. Recommended to be passed via secrets.	''	No
working-directory	The working directory to run the ubc command in. Defaults to the repository root.	${{ github.workspace }}	No

Note: For private projects setting license-key and license-user is required.

Usage

Here is an example of how to use the ubc-action in your workflow to run ubc check on a project located in the demo directory.

# filepath: .github/workflows/check-demo.yml
name: Check demo project with ubc action
on: [push, pull_request]
permissions:
  id-token: write
  contents: read
jobs:

  check:
    runs-on: ubuntu-latest
    
    steps:
      - name: Checkout
        uses: actions/checkout@v5.0.0
        with:
          submodules: "true"

      - name: Setup ubc
        uses: ./
        with:
          license-key: ${{ secrets.UBC_LICENSE_KEY }}
          license-user: ${{ secrets.UBC_LICENSE_USER }}

      - name: Test action with default settings
        working-directory: ./demo
        run: ubc check .

Known Limitations

Windows and macOS runners are not supported at the moment. This action only supports Linux runners.

License

The scripts and documentation in this project are released under the MIT License.