matrix-org / allchange Goto Github PK

The project is lacking a readme for this sort of stuff

Describe the bug
<ol> tags in PR titles aren't escaped

To Reproduce
Generate changelog for something including matrix-org/matrix-react-sdk#8211 (eg. v1.1.0.9)

Expected behavior
Escaped <ol> in backticks

Every release of Element Web corresponds to a release of the JS and React SDK. However, the link between version numbers is tricky to understand when looking at just the Element Web release notes. It'd be good if the SDK versions used to build a release could also be included in the notes.

as seen by matrix-org/matrix-js-sdk#2531 - the template has Notes: add super cool feature but it's within HTML comments to try and prevent the changelog from being used.

The GitHub API returns 'contributor' for people who are private members of the org when you don't use an access token, so we end up crediting them. We should probably just use an access token.

The T-Epic label should probably be ignored by this project as either it will have a T-Defect/T-Enhancement label or child issues with those labels.

Breaking changes in a dependency will cause the suggested version to get a major bump - we should only be counting breaking changes in the main project.

It gets confused by a PR merged in a fork that's the PRed to the project, eg. the first commit in https://github.com/matrix-org/matrix-react-sdk/pull/6702/commits which is merging upstream into the fork via a PR created by a bot. It then goes looking for that PR (184) on react-sdk which takes ages because it goes backwards through the pages.

It should probably:

1. Fall back to fetching PR data individually once it has only one (or maybe small-number) left to fetch: paginating through is silly when you could just fetch it directly. We'd need to check github's rest API actually returns the same shape object from an item in 'list pulls' and 'get individual pull': it probably doesn't: if not, work around this some other way.
2. Check the merge commit shas in the git history and the PR metadata actually match, and discard it if not.