Add a changelog checker script #382
Conversation
Co-authored-by: Richard van der Hoff <[email protected]>
scripts-dev/check_newsfragment.sh
Outdated
|
|
||
| # Print a link to the contributing guide if the user makes a mistake | ||
| CONTRIBUTING_GUIDE_TEXT="!! Please see the contributing guide for help writing your changelog entry: | ||
| https://github.com/matrix-org/sygnal/blob/main/CONTRIBUTING.md#changelog" |
There was a problem hiding this comment.
Are we using Sygnal's contributions guidelines on purpose? Shouldn't we copy them over to Sydent instead?
There was a problem hiding this comment.
Copying them wouldn't make sense, and didn't want this to get blocked behind writing new ones
There was a problem hiding this comment.
I hadn't noticed this. I think it might be better just not to write anything than to link to the CONTRIBUTING from another project.
There was a problem hiding this comment.
For what it's worth, in the PR template we link to Synapse's :D.
There was a problem hiding this comment.
I've put up a PR (#393) which includes enough of the contributing guide to include the changelog entry guide. (I think it's fairly important to have a reference for it, because I doubt I would personally know what to do if I didn't already know from Synapse/Sygnal).
scripts-dev/check_newsfragment.sh
Outdated
|
|
||
| # Print a link to the contributing guide if the user makes a mistake | ||
| CONTRIBUTING_GUIDE_TEXT="!! Please see the contributing guide for help writing your changelog entry: | ||
| https://github.com/matrix-org/sygnal/blob/main/CONTRIBUTING.md#changelog" |
There was a problem hiding this comment.
I hadn't noticed this. I think it might be better just not to write anything than to link to the CONTRIBUTING from another project.
scripts-dev/check_newsfragment.sh
Outdated
| # 1: the newsfragment is wrong in some way | ||
| # 9: the script has not been invoked properly | ||
|
|
||
| echo -e "+++ \033[32mChecking newsfragment\033[m" |
There was a problem hiding this comment.
bit odd to mix \033 and \e in the same file, but 🤷♂️
There was a problem hiding this comment.
I nicked it from Synapse, but good spot. I'll use \e for both (TIL that there's \e for escape!) for the sake of doing the right thing :).
No description provided.