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 #259

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/actionsThis 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 GAP_PKGS_TO_BUILD and GAP_PKGS_TO_CLONE in the .github/workflows/CI.yml file as described further below.

The added GitHub action CI contains a job test, 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 CI also contains a job manual, 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:

git remote add ssiccha https://github.com/ssiccha/GaussPar
git checkout ss/add-GitHub-actions-for-package-tests
# Add and commit your changes
...
git push

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

codecov-io commented 3 years ago

Codecov Report

Merging #259 (10dd6d0) into master (9acb1f6) will increase coverage by 2.53%. The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #259      +/-   ##
==========================================
+ Coverage   91.21%   93.75%   +2.53%     
==========================================
  Files          17       19       +2     
  Lines        2095     1329     -766     
==========================================
- Hits         1911     1246     -665     
+ Misses        184       83     -101     
Impacted Files Coverage Δ
read.g 93.33% <0.00%> (-6.67%) :arrow_down:
gap/benchmarking/measure_contention.g 66.66% <0.00%> (ø)
gap/benchmarking/timing.g 94.44% <0.00%> (ø)
PackageInfo.g 100.00% <0.00%> (+4.30%) :arrow_up:
tst/testall.g 100.00% <0.00%> (+8.33%) :arrow_up:
gap/main.gd 100.00% <0.00%> (+12.50%) :arrow_up:
init.g 100.00% <0.00%> (+21.57%) :arrow_up:

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 9acb1f6...10dd6d0. Read the comment docs.