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

Add plainmarkdown breaking change entry to v0.19.0 changelog #358

Merged
merged 1 commit into from
Apr 18, 2024

Conversation

SBGoods
Copy link
Contributor

@SBGoods SBGoods commented Apr 17, 2024

Closes: #355

PR #332 refactored the mdplain package and reimplemented the plainmarkdown function using the yuin/goldmark library. The purpose of the plainmarkdown function is to strip out markdown elements to render the input as plain text, primarily for the YAML frontmatter. The previous implementation of plainmarkdown still kept some markdown formatting elements such as links and bulletpoints but removed others like headers. The new implementation in PR #332 now strips out all markdown formatting elements but a changelog entry associated with this change was not included in the v0.19.0 release.

This PR retroactively adds a changelog entry into the Changie 0.19.0.md changelog file and CHANGELOG.md

@SBGoods SBGoods requested a review from a team as a code owner April 17, 2024 22:00
@SBGoods SBGoods added this to the v0.19.0 milestone Apr 17, 2024
@SBGoods SBGoods added documentation Improvements or additions to documentation command/generate labels Apr 17, 2024
Copy link
Contributor

@bflad bflad left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me 🚀

@SBGoods SBGoods merged commit e6e13a7 into main Apr 18, 2024
6 checks passed
@SBGoods SBGoods deleted the SBGoods/v0.19.0-changlelog-fix branch April 18, 2024 14:18
Copy link

I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active contributions.
If you have found a problem that seems related to this change, 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 May 23, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
command/generate documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[BUG] Generation with version v0.19.0 removes links and bulletpoints
2 participants