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

Changelog generation broken in tag mode #171

Closed
danth opened this issue Feb 15, 2020 · 3 comments · Fixed by #486
Closed

Changelog generation broken in tag mode #171

danth opened this issue Feb 15, 2020 · 3 comments · Fixed by #486
Labels
bug Something isn't working properly help-wanted Extra attention is required ★★★

Comments

@danth
Copy link
Member

danth commented Feb 15, 2020

Splitting #109 (comment) off into a separate issue.

I'm having some trouble getting release notes to publish to GitHub. Here's the relevant section from the debug log:

Updating changelog
New release published
Wed, 12 Feb 2020 23:34:00 GMT semantic_release:hvcs 'get_hvcs: hvcs=' 'github' +7.1s
Wed, 12 Feb 2020 23:34:00 GMT semantic_release:history:logs 'generate_changelog("0.4.0", "1.0.0")' +7.1s
Wed, 12 Feb 2020 23:34:00 GMT semantic_release:history:logs 'markdown_changelog(version="1.0.0", header=False, changelog=...)' +4.2ms
Wed, 12 Feb 2020 23:34:00 GMT semantic_release:hvcs 'post_changelog(owner=AlphaMycelium, repository=numunit, version=1.0.0)' +4.4ms
Wed, 12 Feb 2020 23:34:00 GMT semantic_release:hvcs 'get_hvcs: hvcs=' 'github' +71.75us
Wed, 12 Feb 2020 23:34:00 GMT semantic_release:hvcs:github 'listing releases' +0.0us
Wed, 12 Feb 2020 23:34:01 GMT semantic_release:hvcs:github 'response #1, status_code=201, status=True' +235.7ms

The created release does not contain the Markdown changelog but instead just the version number.

@danth
Copy link
Member Author

danth commented Feb 21, 2020

Found the cause of this bug. When version_source=tag, no new commits are created containing the version number. So, during generation of the changelog, we skip straight over where the version begins:

https://github.com/relekang/python-semantic-release/blob/e427658e33abf518191498c3142a0f18d3150e07/semantic_release/history/logs.py#L108-L111

Therefore the generated changelog is blank and GitHub replaces it with the tag message automatically.

@danth danth changed the title Release notes not posting properly Changelog generation broken in tag mode Feb 28, 2020
@danth danth added the bug Something isn't working properly label Mar 26, 2020
@danth danth added the help-wanted Extra attention is required label Apr 15, 2020
@danth danth added this to the Better Changelogs milestone Apr 27, 2020
@rpocase
Copy link

rpocase commented Apr 21, 2021

Any movement on this? I'm switching our CI to us semantic-release version with the tags option to avoid pushing commits from the pipeline. Currently, this defect means I'll just lose changelog generation. Not the end of the world, but not ideal either.

@github-actions github-actions bot removed the help-wanted Extra attention is required label Apr 22, 2021
@github-actions
Copy link

This bug report has been labelled as help wanted since there has been no activity in the last 3 weeks. It will not be closed.

@github-actions github-actions bot added the help-wanted Extra attention is required label May 13, 2021
betaboon added a commit to betaboon/python-semantic-release that referenced this issue Aug 5, 2022
betaboon added a commit to betaboon/python-semantic-release that referenced this issue Aug 5, 2022
betaboon added a commit to betaboon/python-semantic-release that referenced this issue Oct 18, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working properly help-wanted Extra attention is required ★★★
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants