8000 Update link to gcovr documentation in HTML. by Spacetown · Pull Request #723 · gcovr/gcovr · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Update link to gcovr documentation in HTML. #723

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
Merged
merged 6 commits into from
Feb 21, 2023
Merged

Update link to gcovr documentation in HTML. #723

merged 6 commits into from
Feb 21, 2023

Conversation

Spacetown
Copy link
Member

The existing reports always linked to the latest version of the documentation. This PR changes the link to point to the documentation of the version used to create the current page.

The version is also set to master on the development branch. If someone installs the current master branch and calls pip freeze the version is shown as gcovr==5.2 which isn't the truth.
When bumping the new version we should change it back to master after the release.

@Spacetown Spacetown added this to the 6.0 milestone Feb 19, 2023
@latk
Copy link
Member
latk commented Feb 20, 2023

Oh this is good.

But instead of using the label master as a version we should likely use a local version identifier like 5.2+master. Ideally, we'd use the Git commit as the local version, but I have no idea how that can be retrieved in a robust manner.

Would such versions require updates to the release checklist script? Could it work somewhat robustly by stripping off the local version part from a version number? In any case, it should check that a release proceeds only with a valid public version number.

@Spacetown
Copy link
Member Author

Oh this is good.

But instead of using the label master as a version we should likely use a local version identifier like 5.2+master. Ideally, we'd use the Git commit as the local version, but I have no idea how that can be retrieved in a robust manner.

Would such versions require updates to the release checklist script? Could it work somewhat robustly by stripping off the local version part from a version number? In any case, it should check that a release proceeds only with a valid public version number.

Master doesn't work. I'm working on the checklist and will force a push if it's working.

@codecov
Copy link
codecov bot commented Feb 20, 2023 •
edited
Loading

Codecov Report

Base: 95.58% // Head: 94.27% // Decreases project coverage by -1.31% ⚠️

Coverage data is based on head (d23ddea) compared to base (9c3771c).
Patch has no changes to coverable lines.

❗ Current head d23ddea differs from pull request most recent head acc5cab. Consider uploading reports for the commit acc5cab to get more accurate results

Additional details and impacted files 
@@            Coverage Diff             @@
##           master     #723      +/-   ##
==========================================
- Coverage   95.58%   94.27%   -1.31%     
==========================================
  Files          28       28              
  Lines        3850     3846       -4     
  Branches      672      672              
==========================================
- Hits         3680     3626      -54     
- Misses         92      140      +48     
- Partials       78       80       +2
Flag Coverage Δ
ubuntu-20.04 94.27% <ø> (ø)
windows-2019 ?

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
gcovr/tests/test_html_generator.py 50.00% <0.00%> (-50.00%) ⬇️
gcovr/utils.py 79.89% <0.00%> (-12.89%) ⬇️
gcovr/tests/test_gcovr.py 91.17% <0.00%> (-6.48%) ⬇️
gcovr/gcov.py 77.09% <0.00%> (-0.73%) ⬇️
gcovr/coverage.py 97.22% <0.00%> (-0.33%) ⬇️
gcovr/workers.py 98.85% <0.00%> (-0.03%) ⬇️
gcovr/writer/html.py
gcovr/writer/html/__init__.py 94.94% <0.00%> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@Spacetown Spacetown marked this pull request as ready for review February 21, 2023 18:59
@Spacetown Spacetown merged commit 168ba6f into gcovr:master Feb 21, 2023
@Spacetown Spacetown deleted the extend_html_report branch February 21, 2023 19:00
D-Walther pushed a commit to D-Walther/gcovr that referenced this pull request Jun 16, 2025
@Spacetown
Update link to gcovr documentation in HTML. (gcovr#723)
adaf20f 
* Move template and html writer to a separate directory.
* Extend link to documentation with version of gcovr.
* Change current version to `5.2+master` to distinguish between the latest released version.
* Respect encoding when updating reference data.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
Format: HTML Type: Enhancement
Projects
None yet
Milestone
6.0
Development

Successfully merging this pull request may close these issues.
2 participants
@Spacetown @latk
0