Fix truncated checklist issue generation #274
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The previous version of the code didn't expect the body of a template to include the "---" horizontal separator, so it discarded content after the third such separator. Fix this since we're using this mark in templates now. Signed-off-by: Joe Stringer <[email protected]>
This will make it easier to test the template processing. Signed-off-by: Joe Stringer <[email protected]>
Use `X.Y.Z-pre.N` and `X.Y.Z-rc.W` so the internal substitutions work to make the substitutions in the templates. Signed-off-by: Joe Stringer <[email protected]>
Add tests for the set of substitutions that should be applied to GitHub issue templates. Signed-off-by: Joe Stringer <[email protected]>
This test evaluates that the version substitutions in the release templates will work correctly. The downside is that any change to templates will require modifying both the template and the golden file. The good thing is that this can help to detect problems where we write the template in a way that doesn't properly apply the version string substitutions that the tool is intended to apply. Use 'make generate-golden' to regenerate the golden test content from the templates. Signed-off-by: Joe Stringer <[email protected]>
There was a bug in the checklist substitution which caused issue content following a horizontal separator to be discarded rather than posted into the target issue. Add a test to catch this case. Signed-off-by: Joe Stringer <[email protected]>
joestringer
force-pushed
the
pr/joe/fix-templates
branch
from
8119cde
to
d0c8fbf
Compare
|
(Swapped test library to |
aanm
approved these changes
Nov 7, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fix a bug where release issue templates would be truncated before posting them
to GitHub whenever they included a horizontal separator (
---).While we're at it, add tests for the templating functionality to ensure that
the templates are processed correctly to generate issues with all version
numbers substituted. Use golden tests for this (generate with
make generate-golden). This also required updating the templates to match theversion substitutions supported by the checklist open command.
Review commit-by-commit.
Fixes: #256
Fixes: #261