Commit 905838f
authored
feat: enable require-pr-numbers flag for changelog generation (MetaMask#23661)
## **Description**
This PR updates the changelog workflows to use the new
`@metamask/auto-changelog@5.3.0` which always filters out direct commits
without PR numbers. This ensures all changelog entries represent
reviewed and approved changes.
**Changes:**
- Update `@metamask/auto-changelog` from `^5.1.0` to `^5.3.0`
- Update `update-release-changelog` workflow to use
`github-tools@v1.1.2`
The `--requirePrNumbers` flag is now always applied by default in
github-tools, so no additional configuration is needed.
This aligns `metamask-mobile` with `metamask-extension` for consistent
changelog generation across platforms.
## **Changelog**
CHANGELOG entry: null
## **Related issues**
- Related to:
[MetaMask/metamask-extension#38520](MetaMask/metamask-extension#38520)
- ✅
[MetaMask/auto-changelog#253](MetaMask/auto-changelog#253)
- Merged (v5.3.0)
- ✅
[MetaMask/github-tools#181](MetaMask/github-tools#181)
- Merged and released as v1.1.2
## **Manual testing steps**
```gherkin
Feature: Changelog generation with PR number filtering
Scenario: Only PR commits appear in changelog
Given a release branch exists
When a commit with an associated PR is merged
Then the changelog should include that commit
When a direct commit without PR is pushed
Then the changelog should NOT include that commit
```
Tested on
[consensys-test/metamask-extension-test](https://github.com/consensys-test/metamask-extension-test)
with `release/1100.0.0`:
- [Generated
changelog](https://github.com/consensys-test/metamask-extension-test/blob/release/1100.0.0-Changelog/CHANGELOG.md)
## **Screenshots/Recordings**
### **Before**
Direct commits without PR numbers would appear in the changelog.
### **After**
Only commits with PR numbers (representing reviewed changes) appear in
the changelog.
## **Pre-merge author checklist**
- [x] I've followed [MetaMask Contributor
Docs](https://github.com/MetaMask/contributor-docs) and [MetaMask Mobile
Coding
Standards](https://github.com/MetaMask/metamask-mobile/blob/main/.github/guidelines/CODING_GUIDELINES.md).
- [x] I've completed the PR template to the best of my ability
- [x] I've included tests if applicable
- [x] I've documented my code using [JSDoc](https://jsdoc.app/) format
if applicable
- [ ] I've applied the right labels on the PR (see [labeling
guidelines](https://github.com/MetaMask/metamask-mobile/blob/main/.github/guidelines/LABELING_GUIDELINES.md)).
Not required for external contributors.
## **Pre-merge reviewer checklist**
- [ ] I've manually tested the PR (e.g. pull and build branch, run the
app, test code being changed).
- [ ] I confirm that this PR addresses all acceptance criteria described
in the ticket it closes and includes the necessary testing evidence such
as recordings and or screenshots.1 parent fa5f8bc commit 905838f
3 files changed
Lines changed: 8 additions & 8 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
48 | 48 | | |
49 | 49 | | |
50 | 50 | | |
51 | | - | |
| 51 | + | |
52 | 52 | | |
53 | 53 | | |
54 | 54 | | |
55 | 55 | | |
56 | 56 | | |
57 | | - | |
| 57 | + | |
58 | 58 | | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
497 | 497 | | |
498 | 498 | | |
499 | 499 | | |
500 | | - | |
| 500 | + | |
501 | 501 | | |
502 | 502 | | |
503 | 503 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
7587 | 7587 | | |
7588 | 7588 | | |
7589 | 7589 | | |
7590 | | - | |
7591 | | - | |
7592 | | - | |
| 7590 | + | |
| 7591 | + | |
| 7592 | + | |
7593 | 7593 | | |
7594 | 7594 | | |
7595 | 7595 | | |
| |||
7600 | 7600 | | |
7601 | 7601 | | |
7602 | 7602 | | |
7603 | | - | |
| 7603 | + | |
7604 | 7604 | | |
7605 | 7605 | | |
7606 | 7606 | | |
| |||
35962 | 35962 | | |
35963 | 35963 | | |
35964 | 35964 | | |
35965 | | - | |
| 35965 | + | |
35966 | 35966 | | |
35967 | 35967 | | |
35968 | 35968 | | |
| |||
0 commit comments