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

Make Towncrier compatible with the release script #1196

Merged
merged 4 commits into from
Aug 11, 2021

Conversation

manuroe
Copy link
Contributor

@manuroe manuroe commented Aug 11, 2021

Final part of element-hq/element-ios#4393

The release script needs to add an entry to CHANGES.md to indicate dependency updates like at https://github.com/vector-im/element-ios/blame/v1.4.9/CHANGES.rst#L68.
We want to use towncrier but we have no issue number for doing releases. We could get the release PR number but this is complex to implement. So we have no number that will allow towncrier to build and add a link to a release change.

With this template update, the new filename rule (x-nolink-) allows to add an entry to CHANGES.md without any link automatically built by towncrier.


The last commit is for having a valid MD link for PR changelog entry like:

🧱 Build

Source:

🧱 Build

- CHANGES.md: Use towncrier to manage the change log. More info in [CONTRIBUTING](CONTRIBUTING.md#changelog). ([#1196](https://github.com/matrix-org/matrix-ios-sdk/pull/1196), [#4393](https://github.com/vector-im/element-ios/issues/4393))

CONTRIBUTING.md Outdated Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants