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

feat: allow custom notes in body text #1997

Closed
wants to merge 3 commits into from

Conversation

btkostner
Copy link
Contributor

Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:

  • Make sure to open an issue as a bug/issue before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
  • Ensure the tests and linter pass
  • Code coverage does not decrease (if any source code was changed)
  • Appropriate docs were updated (if necessary)

Fixes #1274

This allows setting up custom notes in release changelogs as described in #1274. It does so by parsing magic strings in the commit message and setting the parsed text as a note. Because we are pigging back off notes, support for rendering this information is already done. Let me know how you feel about this approach and I can update as needed.

@btkostner btkostner requested review from a team as code owners June 28, 2023 22:56
@product-auto-label product-auto-label bot added the size: m Pull request size is medium. label Jun 28, 2023
@btkostner
Copy link
Contributor Author

I just realized that the template will not render these notes like I want. I’ll update and add more tests in that area.

@chingor13
Copy link
Contributor

I’ll update and add more tests in that area.

If you ever get back to this, feel free to re-open. The annotations used might warrant more discussion in the feature request issue though.

@chingor13 chingor13 closed this Dec 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
size: m Pull request size is medium.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Additional custom description for Releases
2 participants