lbfm-rwth / GaussParallel

https://lbfm-rwth.github.io/GaussParallel/
GNU General Public License v2.0
2 stars 5 forks source link

Add GitHub action for CI tests #258

Closed ssiccha closed 3 years ago

ssiccha commented 3 years ago

This PR configures GitHub Actions to run the package tests. It was created by a script. You can view the results of the added GitHub action under: https://github.com/ssiccha/GaussPar/actions

This PR contains four commits which do:

Since this PR is generated automatically, please double-check that the last three commits do not break anything. You may also have to specify values for the variables and in file as described further below.

The added GitHub action contains a job , which runs your package's tests using the same scripts as previously did Travis, namely those from https://github.com/gap-system/pkg-ci-scripts By default it tests your package with the following gap branches:

The action also contains a job , which compiles your package's documentation with latex and uploads the resulting pdf as an artifact, which means that it can be downloaded once all jobs of the action completed.If you need to compile packages to load your package, set the input GAP_PKGS_TO_BUILD for the action gap-actions/setup-gap-for-packages@v1 to a space-separated list of packages as follows:

- uses: gap-actions/setup-gap-for-packages@v1
  with:
    GAPBRANCH: ${{ matrix.gap-branch }}
    GAP_PKGS_TO_BUILD: "<list-of-packages>"

If you need to clone the development version of packages set the input GAP_PKGS_TO_CLONE for the action gap-actions/setup-gap-for-packages@v1 to a space-separated list of packages as follows:

- uses: gap-actions/setup-gap-for-packages@v1
  with:
    GAPBRANCH: ${{ matrix.gap-branch }}
    GAP_PKGS_TO_CLONE: "<list-of-packages>"

Notice that you may also have to set inputs for the action gap-actions/setup-gap-for-packages@v1 in the job manual.

If you want to adjust which tests are run have a look at the documentation of the job matrix.You can add changes to this PR by adding my fork as a remote, checking it out and then committing and pushing as follows:

The custom gap actions which are used by the added action can be found at: https://github.com/gap-actions