Piper GitHub Action

🚧 Not available for productive usage yet!

This GitHub action allows running Piper on GitHub Actions.

Usage

This action can be used in a GitHub Actions workflow file as follows:

- uses: SAP/project-piper-action@main
# or if you want to pin specific version use @v1.0.0 instead of @main
  with:
    step-name: mavenBuild
    flags: '--publish --createBOM --logSuccessfulMavenTransfers'

Please refer to the GitHub Actions documentation for more information.

Parameters

The step-name parameter can be one of Piper's internal or open source steps. The respective Piper binary is selected automatically.

Other inputs are listed in the action.yml file.

Step Configuration

Piper step configuration is either done via Piper's configuration file in your project's repository or via step parameters passed to the step via the action's flags parameter.

See Piper's docs section about configuration for more information.

Secrets

Piper can load secrets directly from Vault if Vault approle roleID and secretID are provided via environment variables.

env:
  PIPER_vaultAppRoleID: ${{ secrets.PIPER_VAULTAPPROLEID }}
  PIPER_vaultAppRoleSecretID: ${{ secrets.PIPER_VAULTAPPROLESECRETID }}

See also Piper's Vault documentation.