This PR introduces test reports to the repository.
When GitHub actions are run a report is uploaded to a new gh-pages branch, and a link to a URL showcasing the test-report is printed in the test log, specifically under the "Display Report URL" section.
Resolved Issue
Fixes #22
Changes
Installed packages, and expanded the GitHub Actions .yaml.
Specifically, the workflow now creates and uploads a test report - this can be downloaded as a .zip if desired.
The uploaded report is duplicated to a new gh-pages branch, which are meant to serve the static html files.
Additional Information
Things to consider:
The gh-pages branch are meant to stay - it should have no ties to the business logic of the repo, simply it acts as a holder of the test report.
Currently unknown if the test report on the branch is overwritten on every run of GitHub actions, or if they are simply added (a report is 30-ish different files, which will increase along with the files of the repo). If the files are added for every run of GitHub Actions, modifictions should be made, to have the branch automatically clean itself.
Ideally, the coverage report would be easier accessible, than accessing the test log, however, this was the most convenient solution I could come up with.
If it was possible for the coverage report to display more convenient after the test was run, for instance through the URL being displayed on the actions page, without the need of accessing the logs, it could increase the usefulness of generating coverage reports.
Last consideration is if we are interested in making coverage a hard requirement. It is not relevant in the current stage, as we would not be able to push anything as we currently cover nothing, but we can consider setting a requirement after the MVP is finished.
Description
This PR introduces test reports to the repository.
When GitHub actions are run a report is uploaded to a new
gh-pagesbranch, and a link to a URL showcasing the test-report is printed in the test log, specifically under the "Display Report URL" section.Resolved Issue
Fixes #22
Changes
Installed packages, and expanded the GitHub Actions .yaml.
Specifically, the workflow now creates and uploads a test report - this can be downloaded as a .zip if desired. The uploaded report is duplicated to a new
gh-pagesbranch, which are meant to serve the static html files.Additional Information
Things to consider:
gh-pagesbranch are meant to stay - it should have no ties to the business logic of the repo, simply it acts as a holder of the test report.Checklist