:exclamation: Before merge, we need to create a data and gh-pages branch. :exclamation:
Current Procedure:
create an artifact for each job in the test matrix that contains the result of the job (txt file)
generate a report (md file) that compares these results against latest, which is a symlink to the latest report directory
update latest symlink
generate badge (json file) that is used in README.md (via creating a request to shields.io, a free service that generates and provides this badge)
upload this report to data branch under hash
upload new redirect (html file) to gh-pages that is used in README.md for referencing the latest report (it seems to me that symlinks cannot be redirected natively in github markdown nor github pages; i decided it is better to update the gh-pages branch instead of the README.md on the main branch each time a report is created.)
Missing Features:
[ ] :warning: gap_build_version in the docker does not contain the hash to the commit when it was built
[ ] the workflow pkg-tests.yml uses standard and minimal setup, but we only store the state of minimal setup
Suggestion: store a json file instead of a txt file that only contains the result of the job. This file could also contain metadata about the package, like version and link to github)
[ ] use docker information for saving multiple reports and not just one
[ ] activate reports for all tests and not just pkg-tests.yml
[ ] generation of reports based on trigger via context github.event_name:
[ ] data folder structure
daily contains daily reports from schedule trigger
hash contains reports from pull request trigger or a comment trigger as in Julia
manual contains reports from workflow dispatch trigger
latest symlink to latest report in daily
[ ] for hash compare against latest hash in history that is contained in hash
[x] for others compare against latest
[ ] references to FriedrichRober/integration should be removed.
:exclamation: Before merge, we need to create a
data
andgh-pages
branch. :exclamation:Current Procedure:
latest
, which is a symlink to the latest report directorylatest
symlinkREADME.md
(via creating a request toshields.io
, a free service that generates and provides this badge)data
branch under hashgh-pages
that is used inREADME.md
for referencing the latest report (it seems to me that symlinks cannot be redirected natively in github markdown nor github pages; i decided it is better to update thegh-pages
branch instead of theREADME.md
on themain
branch each time a report is created.)Missing Features:
gap_build_version
in the docker does not contain the hash to the commit when it was builtpkg-tests.yml
uses standard and minimal setup, but we only store the state of minimal setuppkg-tests.yml
github.event_name
:daily
contains daily reports fromschedule
triggerhash
contains reports frompull request
trigger or acomment
trigger as in Juliamanual
contains reports fromworkflow dispatch
triggerlatest
symlink to latest report in dailyhash
compare against latest hash in history that is contained inhash
FriedrichRober/integration
should be removed.