Integration with GitHub Actions

Universum requires no special integration with GitHub Actions. It is usually launched as one long step in a single build stage.

Warning

‘GitHub Actions’ CI system is not compatible with report_artifacts configuration Step key. If this key is set nevertheless, links to artifacts will be posted, but won’t work.

Command line

Here’s an example of a command line to be used for running Universum in GitHub Actions:

python -m universum --vcs-type=git --git-repo "${GITHUB_SERVER_URL}/${GITHUB_REPOSITORY}" --git-refspec "${GITHUB_REF_NAME}"

All environment variables mentioned in the example are GitHub Environment variables.

Universum also supports reporting to code review systems (’–report-to-review’ option) from ‘GitHub Actions’. Link to build is created using environment variables and do not require any additional command line parameters.

Logs

GitHub Actions web interface currently supports single-level grouping of log lines (without nesting). Because of that, Universum logs are printed as follows: an already opened group is closed if any other (including nested) group is opened.

Artifacts

Artifacts can be stored in GitHub Actions with explicitly provided name via separate workflow step. It is possible to store multiple files in a single artifact, but it is not possible to retrieve only one file from such artifact. This leads to the following limitations:

• links to GitHub Actions artifacts can only be retrieved after actual artifact creation (which happens after Universum run)

• links to single artifact files cannot be provided at all

This is the reason the report_artifacts key can not be processed correctly and shouldn’t be set in configuration.