Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add coverage report to documentation #481

Merged
merged 8 commits into from
Jun 4, 2024

Conversation

JulienDoerner
Copy link
Member

With this PR the coverage report is added to the documentation.
The Github action is adopted to copy the report into the documentation part and a link to the files is added.

In case of a manual build of the documentation the coverage report has to be copied by hand to the right location. In the build folder it is done by:

cp -r coverageReport doc/pages/coverageReport

@lukasmerten
Copy link
Member

If we are on the automatic creation of the documentaion, we could also think about automatic deployment to gh-pages.

- name: deploy documentation #deploys the documentation to the gh-pages branch
uses: JamesIves/github-pages-deploy-action@v4
with:
folder: ./build/doc

Following this description here: https://github.com/JamesIves/github-pages-deploy-action

In case this seems to be useful, I'll can either provide a new PR or just add to this one.

@JulienDoerner
Copy link
Member Author

I will add the deployment in this PR. For the testing phase I will convert it to draft and notify you when it is ready.

@JulienDoerner JulienDoerner marked this pull request as draft April 17, 2024 09:36
@JulienDoerner
Copy link
Member Author

I changed the workflows accordingly.
Now the steps are seperated in three different task

  1. The create_documentation builds the docu and uploads the artifact. The coverage report is only included in the documentation and not seperatly stored.
  2. The create_coverage_report builds the coverage report and uploads it as an artifact. This can be used to check the changes with new PRs.
  3. The deploy_new_documentation workflow builds the new documentation and push it automaticly to the gh-pages branch. This works in my fork, but we might have to check the permissions. It is configured to run in all cases, where we push to the master branch. This should be done as the coverage report and the API information are changed with all changes on the master branch.

@JulienDoerner JulienDoerner marked this pull request as ready for review April 17, 2024 12:23
@@ -16,3 +16,6 @@ make test
make coverage
```
The final report is in ```~/build/coverageReport/index.html```

### coverage report of the current master branch
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Coverage Report

@@ -16,3 +16,6 @@ make test
make coverage
```
The final report is in ```~/build/coverageReport/index.html```

### coverage report of the current master branch
The coverage report of the current master branch can be accesed `by clicking here <coverageReport/index.html>`_ now.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The most recent coverage report is linked here.

.github/workflows/create_documentation.yml Show resolved Hide resolved
@lukasmerten lukasmerten merged commit a6dbe04 into CRPropa:master Jun 4, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants