Check if issue is mentioned in changelog.

[Spacetown]

Test was mentioned in #424. The check can be deactivated by adding the text "[no changelog]" to a single line in the comment.

[codecov]

Codecov Report

Merging #457 (b328b45) into master (7a1b38e) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #457   +/-   ##
=======================================
  Coverage   95.49%   95.49%           
=======================================
  Files          20       20           
  Lines        2444     2444           
  Branches      420      420           
=======================================
  Hits         2334     2334           
  Misses         48       48           
  Partials       62       62           

Flag	Coverage Δ
ubuntu-18.04	95.00% <ø> (ø)
windows-2019	95.08% <ø> (ø)

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

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 7a1b38e...b328b45. Read the comment docs.

[chrta]

Code looks good. I have 2 questions:

1. Should the check be mentioned in https://gcovr.com/en/stable/contributing.html#how-to-submit-a-pull-request? Also the fact that adding [no changelog] can be added there for minor changes.
2. Do i understand correctly that adding [no changelog] to any commit message skips the check? So it is not necessary to add this to all commits in a pr, only to one commit.

[latk]

As an alternative to looking at commit messages, we could consider looking at the pull request comment via the Github API. This would likely mean that the check would be performed only in the Action, not in the release checklist. In a shell script, the PR comment can be extracted like:

curl https://api.github.com/repos/gcovr/gcovr/pulls/457 | jq -r .body

However, I have no strong preference regarding PR comment vs commit message as the source for these tags. My concern with commit messages would be that a PR with multiple commits could include both commits with changes that don't have to be mentioned in the Changelog, and other commits with changes that should be mentioned nevertheless. A PR message would be easier to change afterwards during review. The advantage of commit messages is that they can be checked locally and without network connectivity.

But I do like that this PR introduces more structure into the CI pipelines!

[Spacetown]

1. Should the check be mentioned in https://gcovr.com/en/stable/contributing.html#how-to-submit-a-pull-request? Also the fact that adding [no changelog] can be added there for minor changes.

Of course.

2. Do i understand correctly that adding [no changelog] to any commit message skips the check? So it is not necessary to add this to all commits in a pr, only to one commit.

This was the intention but I find this idea better:

As an alternative to looking at commit messages, we could consider looking at the pull request comment via the Github API. This would likely mean that the check would be performed only in the Action, not in the release checklist.

Instead of using curl I'll try to use the available PR info in the pipeline and directly write the script there. I think the local check isn't realy needed because it is only needed for PR's and not for playing in the local clone.
With every approach we have the problem that the PR number is realy known after creating the PR.

[latk]

LGTM :)

Thanks for implementing this! Automating such checks will help future releases to be ready more quickly.

[Spacetown]

@chrta @latk: For the main branch the test is turned of. I'll create a new PR in the afternoon.

[gobater]

@Spacetown : please update documentation on this topic in https://gcovr.com/en/stable/contributing.html#how-to-submit-a-pull-request

[Spacetown]

@Spacetown : please update documentation on this topic in https://gcovr.com/en/stable/contributing.html#how-to-submit-a-pull-request

That's the documentation of the stable version. Please take a look at the latest source https://github.com/gcovr/gcovr/blob/master/CONTRIBUTING.rst#how-to-submit-a-pull-request