chore(tools): Use PR number in changeset titles when Issue is absent #3152
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
…g changeset with no Issue Previously, it was just leaving it off, but it left things a bit unharmonic/off-balance in terms of the resulting changeset template. I'd also just been manually adding those during the release process thus far, so figured I'd just automate it now. Also, added insta tests that make sure things are rendering properly.
|
@abernix, please consider creating a changeset entry in |
|
CI performance tests
|
abernix
commented
May 26, 2023
Comment on lines
+70
to
+85
| {{- if issues -}} | ||
| {{- if issues }} {{ endif -}} | ||
| {{- for issue in issues -}} | ||
| ([Issue #{issue.number}]({issue.url})) | ||
| {{- if not @last }}, {{ endif -}} | ||
| {{- endfor -}} | ||
| {{ else -}} | ||
| {{- if pulls -}} | ||
| {{- if pulls }} {{ endif -}} | ||
| {{- for pull in pulls -}} | ||
| ([PR #{pull.number}]({pull.url})) | ||
| {{- if not @last }}, {{ endif -}} | ||
| {{- endfor -}} | ||
| {{- else -}} | ||
| {{- endif -}} | ||
| {{- endif }} |
There was a problem hiding this comment.
Having this more nicely formatted is... nice. :) There are some bug-fixes in there, too, and then the actual feature that this PR claims to add.
Comment on lines
+89
to
+91
| By [@{author}](https://github.com/{author}){{ if pulls }} in {{ for pull in pulls -}} | ||
| {pull.url}{{ if not @last }}, {{ endif }} | ||
| {{- endfor }} | ||
| {{- endfor }}{{ endif }} |
There was a problem hiding this comment.
Note: There is no condition in the code today that actually results in there being multiple pulls members, but this template still supports it. A future state can support it easily.
o0Ignition0o
approved these changes
May 26, 2023
Geal
approved these changes
May 26, 2023
| {{- endfor }} | ||
| const EXAMPLE_TEMPLATE: &'static str = "### { title } | ||
| {{- if issues -}} | ||
| {{- if issues }} {{ endif -}} |
There was a problem hiding this comment.
Suggested change
| {{- if issues }} {{ endif -}} |
shouldn't this be removed?
There was a problem hiding this comment.
Good eye and question, but no and hard to comment in the code (since it's within a template) why it exists. It actually allows me to:
- use a nice formatted structure for this template
- while ensuring that there will be a space preserved there at all times
- while not leaving a trailing whitespace on the
### titleline which would almost certainly get removed by someone's editor.
Merged
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.
Previously, it was just leaving it off, but it left things a bit
unharmonic/off-balance in terms of the resulting changeset template. I'd
also just been manually adding those during the release process thus far, so
figured I'd just automate it now.
Also added a lot of tests and fixed a couple bugs with trailing spaces.
Relates to ##2261