gh-428: Add GitHub issue to description of PR

[ryanlong1004]

Closes #428

[ghost]

All commit authors signed the Contributor License Agreement.

[hugovk]

@ryanlong1004 Please can you resolve the conflicts?

[codecov]

Codecov Report

Merging #430 (b302bf8) into main (77db0d5) will not change coverage.
The diff coverage is 100.00%.

@@            Coverage Diff            @@
##              main      #430   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           18        18           
  Lines         1720      1760   +40     
  Branches       208       213    +5     
=========================================
+ Hits          1720      1760   +40     

Flag	Coverage Δ
Python_3.10	100.00% <100.00%> (?)
Python_3.11-dev	100.00% <100.00%> (?)
Python_3.8	100.00% <100.00%> (?)
Python_3.9	100.00% <100.00%> (?)

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

Impacted Files	Coverage Δ
bedevere/util.py	100.00% <100.00%> (ø)
tests/test_gh_issue.py	100.00% <100.00%> (ø)
tests/test_stage.py	100.00% <100.00%> (ø)
tests/test_util.py	100.00% <100.00%> (ø)
bedevere/news.py	100.00% <0.00%> (ø)

[JelleZijlstra]

Why is there a closing tag but no opening tag?

I'm not sure what the tag is for, but my best guess is that it's so the bot can reliably recognize that it has already added a link. So maybe we should also add an open tag and use that to check whether to add the issue number.

[ryanlong1004]

Taken from link below. There was no opening tag there.
https://github.com/python/bedevere/blob/3d532cd90271a506ad222af42dbaacb8139c1138/bedevere/bpo.py

[erlend-aasland]

@JelleZijlstra, can this conversation be resolved?

[JelleZijlstra]

The old code did have an opening tag:

bedevere/bedevere/bpo.py

Line 15 in 3d532cd

<!-- {TAG_NAME}: bpo-{{issue_number}} -->

[JelleZijlstra]

Though it seems we're not using the tag now. If so, we should remove the closing tag too.

[ezio-melotti]

I think the tag was added there to make it easier to parse it, e.g. if one day we migrate again.

[Mariatta]

Thanks for your work @ryanlong1004!

Would you be able to increase the coverage to 100%?

[erlend-aasland]

@Mariatta, you requested changes. Are you happy with the PR as it stands? Please mark it approved, if so.