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

Fix CHANGELOG.md markdown #130

Closed
maunzCache opened this issue Feb 3, 2022 · 4 comments · Fixed by #133
Closed

Fix CHANGELOG.md markdown #130

maunzCache opened this issue Feb 3, 2022 · 4 comments · Fixed by #133

Comments

@maunzCache
Copy link

maunzCache commented Feb 3, 2022

Is your request related to a new offering from AWS?

Nope, not at all.

Is your request related to a problem? Please describe.

The markdown of the changelog file is a bit messed up.

Describe the solution you'd like.

The headline "Changelog" is included twice and some versions have mixed up header sizes as well. Also since 2.11.1 versioning scheme has been changed which drops the "v" prefix. I guess this is not correctly documented as the actual tag still contain that character.

Edit: Oh version 2.3.0 has no changelog at all. Or that is written with magic ink and i cannot get my display to show it.

Describe alternatives you've considered.

Ignoring it but i really cannot :(

Additional context

Include markdownlinter in pre-commit hook

@antonbabenko
Copy link
Member

Thanks for reporting this issue. It is weird that the problem is only in this repository and not in VPC module, for example.

/cc @bryantbiggs Do you have any ideas why https://github.com/terraform-aws-modules/terraform-aws-s3-bucket/blob/master/CHANGELOG.md looks broken?

@bryantbiggs
Copy link
Member

looks like when I did the switchover from gitchglog to semantic-release, I just forgot to clear the header from the existing changelog file fa76ac6

the differences over time in the release titles is due to two different tools used (gitchnglog and semantic-release)

@antonbabenko
Copy link
Member

This issue has been resolved in version 2.14.0 🎉

@github-actions
Copy link

I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues. If you have found a problem that seems similar to this, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Oct 28, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants