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.

Sign up for GitHub

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

Jump to bottom

Add Test Coverage and "Documentation Building" Badge to README #24

Closed
MarcoHuebner opened this issue Oct 31, 2023 · 1 comment · Fixed by #59
Closed

Add Test Coverage and "Documentation Building" Badge to README #24

MarcoHuebner opened this issue Oct 31, 2023 · 1 comment · Fixed by #59
Assignees
@PiaSchroeder @MarcoHuebner
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@MarcoHuebner
Copy link
Collaborator

No description provided.

@MarcoHuebner MarcoHuebner added documentation Improvements or additions to documentation enhancement New feature or request labels Oct 31, 2023
@MarcoHuebner
Copy link
Collaborator Author

A Sphinx documentation badge can also be created using built-in functionality, for code coverage we could either use

  • codecov - free for open-source projects by providing GitHub username, name of the repository, and Codecov token:
[![codecov](https://codecov.io/gh/username/repository/branch/main/graph/badge.svg?token=YOURTOKEN)](https://codecov.io/gh/username/repository)

@MarcoHuebner MarcoHuebner mentioned this issue Dec 3, 2023
Closed
@MarcoHuebner MarcoHuebner mentioned this issue Jan 1, 2024
Closed
MarcoHuebner added a commit that referenced this issue Mar 3, 2024
@MarcoHuebner
Add badges, update workflows & names #24
964ad77
@MarcoHuebner MarcoHuebner mentioned this issue Mar 5, 2024
Merged
MarcoHuebner added a commit that referenced this issue Mar 11, 2024
@MarcoHuebner
Add coverage report upload and update readme badge link #24
7c2df9f
MarcoHuebner added a commit that referenced this issue Mar 11, 2024
@MarcoHuebner
Downgrade artifact for easier compatibility #24
c32c6c5 
See actions/upload-artifact#478
MarcoHuebner added a commit that referenced this issue Mar 17, 2024
@MarcoHuebner
Move and test dev PR coverage and upload to GH pages, update badge link
fa66e0f 
#24
MarcoHuebner added a commit that referenced this issue Mar 17, 2024
@MarcoHuebner
Add html report, fix directory structure, fix content overwriting #24
3d05dd3
MarcoHuebner added a commit that referenced this issue Mar 17, 2024
@MarcoHuebner
Remove previous coverage_badge.json from GH pages, add recursive dire…
d2832e7 
…ctory creation #24
MarcoHuebner added a commit that referenced this issue Mar 17, 2024
@MarcoHuebner
Remove accidentally created file #24
038ba30
MarcoHuebner added a commit that referenced this issue Mar 17, 2024
@MarcoHuebner
Catch mistakes for uploading the coverage_report directory #24
131d23c
MarcoHuebner added a commit that referenced this issue Mar 17, 2024
@MarcoHuebner
Move step in which the html reports are generated #24
2d4625c
MarcoHuebner added a commit that referenced this issue Mar 17, 2024
@MarcoHuebner
Update python code quality version (Version 3.11.6 was not found in t…
89ebc07 
…he local cache) and mkdir coverage_report #24
MarcoHuebner added a commit that referenced this issue Mar 21, 2024
@MarcoHuebner
Fix attempt: Explicitly create all directories #24
9d2d8cb
MarcoHuebner added a commit that referenced this issue Mar 21, 2024
@MarcoHuebner
Fix attempt: Explicitly state publish branch #24
15c56c0
MarcoHuebner added a commit that referenced this issue Apr 27, 2024
@MarcoHuebner
Remove broken link to html coverage report #24
db89ba5
@pmayd pmayd closed this as completed in #59 Apr 30, 2024
pmayd pushed a commit that referenced this issue Apr 30, 2024
@MarcoHuebner
Add badges, update workflows & names #24 (#59)
196ebd1 
* Add badges, update workflows & names #24

* Add coverage report upload and update readme badge link #24

* Downgrade artifact for easier compatibility #24

See actions/upload-artifact#478

* Move and test dev PR coverage and upload to GH pages, update badge link #24

* Add html report, fix directory structure, fix content overwriting #24

* Remove previous coverage_badge.json from GH pages, add recursive directory creation #24

* Catch mistakes for uploading the coverage_report directory #24

* Move step in which the html reports are generated #24

* Update python code quality version (Version 3.11.6 was not found in the local cache) and mkdir coverage_report #24

* Fix attempt: Explicitly create all directories #24

* Fix attempt: Explicitly state publish branch #24

* Remove broken link to html coverage report #24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@PiaSchroeder PiaSchroeder

@MarcoHuebner MarcoHuebner

Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
No milestone
2 participants
@PiaSchroeder @MarcoHuebner