Fix changelog on the release page #18468
Labels
release-12.3.0
Issue or pull request that will be included in release 12.3.0
team-extension-platform
Comments
|
Visible for me
|
Gudahtt
added a commit
that referenced
this issue
Aug 1, 2024
## **Description** For years our release scripts have been creating GitHub releases with empty descriptions. GitHub uses the commit message as the description as a default, which is always a merge commit in our case, whcih isn't very decsriptive. The release scripts are supposed to be setting the changelog entries for the current release as the description. This broke when we last changed our CHANGELOG.md format. Specifically it was the release header change that broke this. We started surrounding the version number in square brackets, which the awk script did not expect. The script that creates the GitHub release has been updated to pass in a version surrounded by square brackets to the awk script, so it is again able to find the relevant changelog entries. [](https://codespaces.new/MetaMask/metamask-extension/pull/26247?quickstart=1) ## **Related issues** Fixes: #18468 ## **Manual testing steps** Start by checking out `master. Then look at the `release-create-gh-release.sh` script, and run the exact same awk command that is shown there. Replace `${tag##v}` with the release version minus the v (e.g. `12.0.0`). Before this PR it was `awk -v version="12.0.0" -f .circleci/scripts/show-changelog.awk CHANGELOG.md`. This produces no output. After this PR, its `awk -v version="[12.0.0]" -f .circleci/scripts/show-changelog.awk CHANGELOG.md`. This produces the correct output. ## **Screenshots/Recordings** N/A ## **Pre-merge author checklist** - [x] I've followed [MetaMask Contributor Docs](https://github.com/MetaMask/contributor-docs) and [MetaMask Extension Coding Standards](https://github.com/MetaMask/metamask-extension/blob/develop/.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 - [x] I’ve applied the right labels on the PR (see [labeling guidelines](https://github.com/MetaMask/metamask-extension/blob/develop/.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.
metamaskbot
added
the
release-12.4.0
Gudahtt
added a commit
that referenced
this issue
Aug 1, 2024
## **Description** For years our release scripts have been creating GitHub releases with empty descriptions. GitHub uses the commit message as the description as a default, which is always a merge commit in our case, whcih isn't very decsriptive. The release scripts are supposed to be setting the changelog entries for the current release as the description. This broke when we last changed our CHANGELOG.md format. Specifically it was the release header change that broke this. We started surrounding the version number in square brackets, which the awk script did not expect. The script that creates the GitHub release has been updated to pass in a version surrounded by square brackets to the awk script, so it is again able to find the relevant changelog entries. [](https://codespaces.new/MetaMask/metamask-extension/pull/26247?quickstart=1) ## **Related issues** Fixes: #18468 ## **Manual testing steps** Start by checking out `master. Then look at the `release-create-gh-release.sh` script, and run the exact same awk command that is shown there. Replace `${tag##v}` with the release version minus the v (e.g. `12.0.0`). Before this PR it was `awk -v version="12.0.0" -f .circleci/scripts/show-changelog.awk CHANGELOG.md`. This produces no output. After this PR, its `awk -v version="[12.0.0]" -f .circleci/scripts/show-changelog.awk CHANGELOG.md`. This produces the correct output. ## **Screenshots/Recordings** N/A ## **Pre-merge author checklist** - [x] I've followed [MetaMask Contributor Docs](https://github.com/MetaMask/contributor-docs) and [MetaMask Extension Coding Standards](https://github.com/MetaMask/metamask-extension/blob/develop/.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 - [x] I’ve applied the right labels on the PR (see [labeling guidelines](https://github.com/MetaMask/metamask-extension/blob/develop/.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.
Gudahtt
added a commit
that referenced
this issue
Aug 1, 2024
## **Description** For years our release scripts have been creating GitHub releases with empty descriptions. GitHub uses the commit message as the description as a default, which is always a merge commit in our case, whcih isn't very decsriptive. The release scripts are supposed to be setting the changelog entries for the current release as the description. This broke when we last changed our CHANGELOG.md format. Specifically it was the release header change that broke this. We started surrounding the version number in square brackets, which the awk script did not expect. The script that creates the GitHub release has been updated to pass in a version surrounded by square brackets to the awk script, so it is again able to find the relevant changelog entries. [](https://codespaces.new/MetaMask/metamask-extension/pull/26247?quickstart=1) ## **Related issues** Fixes: #18468 ## **Manual testing steps** Start by checking out `master. Then look at the `release-create-gh-release.sh` script, and run the exact same awk command that is shown there. Replace `${tag##v}` with the release version minus the v (e.g. `12.0.0`). Before this PR it was `awk -v version="12.0.0" -f .circleci/scripts/show-changelog.awk CHANGELOG.md`. This produces no output. After this PR, its `awk -v version="[12.0.0]" -f .circleci/scripts/show-changelog.awk CHANGELOG.md`. This produces the correct output. ## **Screenshots/Recordings** N/A ## **Pre-merge author checklist** - [x] I've followed [MetaMask Contributor Docs](https://github.com/MetaMask/contributor-docs) and [MetaMask Extension Coding Standards](https://github.com/MetaMask/metamask-extension/blob/develop/.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 - [x] I’ve applied the right labels on the PR (see [labeling guidelines](https://github.com/MetaMask/metamask-extension/blob/develop/.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.
7 tasks
Gudahtt
added a commit
that referenced
this issue
Aug 2, 2024
This is a cherry-pick of #26247 for v12.0.1. Original description: ## **Description** For years our release scripts have been creating GitHub releases with empty descriptions. GitHub uses the commit message as the description as a default, which is always a merge commit in our case, whcih isn't very decsriptive. The release scripts are supposed to be setting the changelog entries for the current release as the description. This broke when we last changed our CHANGELOG.md format. Specifically it was the release header change that broke this. We started surrounding the version number in square brackets, which the awk script did not expect. The script that creates the GitHub release has been updated to pass in a version surrounded by square brackets to the awk script, so it is again able to find the relevant changelog entries. [](https://codespaces.new/MetaMask/metamask-extension/pull/26247?quickstart=1) ## **Related issues** Fixes: #18468 ## **Manual testing steps** Start by checking out `master. Then look at the `release-create-gh-release.sh` script, and run the exact same awk command that is shown there. Replace `${tag##v}` with the release version minus the v (e.g. `12.0.0`). Before this PR it was `awk -v version="12.0.0" -f .circleci/scripts/show-changelog.awk CHANGELOG.md`. This produces no output. After this PR, its `awk -v version="[12.0.0]" -f .circleci/scripts/show-changelog.awk CHANGELOG.md`. This produces the correct output. ## **Screenshots/Recordings** N/A ## **Pre-merge author checklist** - [x] I've followed [MetaMask Contributor Docs](https://github.com/MetaMask/contributor-docs) and [MetaMask Extension Coding Standards](https://github.com/MetaMask/metamask-extension/blob/develop/.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 - [x] I’ve applied the right labels on the PR (see [labeling guidelines](https://github.com/MetaMask/metamask-extension/blob/develop/.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.
dawnseeker8
pushed a commit
that referenced
this issue
Aug 12, 2024
](https://codespaces.new/MetaMask/metamask-extension/pull/26247?quickstart=1){kind=link}
## **Description** For years our release scripts have been creating GitHub releases with empty descriptions. GitHub uses the commit message as the description as a default, which is always a merge commit in our case, whcih isn't very decsriptive. The release scripts are supposed to be setting the changelog entries for the current release as the description. This broke when we last changed our CHANGELOG.md format. Specifically it was the release header change that broke this. We started surrounding the version number in square brackets, which the awk script did not expect. The script that creates the GitHub release has been updated to pass in a version surrounded by square brackets to the awk script, so it is again able to find the relevant changelog entries. [](https://codespaces.new/MetaMask/metamask-extension/pull/26247?quickstart=1) ## **Related issues** Fixes: #18468 ## **Manual testing steps** Start by checking out `master. Then look at the `release-create-gh-release.sh` script, and run the exact same awk command that is shown there. Replace `${tag##v}` with the release version minus the v (e.g. `12.0.0`). Before this PR it was `awk -v version="12.0.0" -f .circleci/scripts/show-changelog.awk CHANGELOG.md`. This produces no output. After this PR, its `awk -v version="[12.0.0]" -f .circleci/scripts/show-changelog.awk CHANGELOG.md`. This produces the correct output. ## **Screenshots/Recordings** N/A ## **Pre-merge author checklist** - [x] I've followed [MetaMask Contributor Docs](https://github.com/MetaMask/contributor-docs) and [MetaMask Extension Coding Standards](https://github.com/MetaMask/metamask-extension/blob/develop/.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 - [x] I’ve applied the right labels on the PR (see [labeling guidelines](https://github.com/MetaMask/metamask-extension/blob/develop/.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.
gauthierpetetin
added
release-12.3.0
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
For 10.28.1, the release page does not include the changelog.
The changelog should be included as in previous releases such as 10.27.0.
The text was updated successfully, but these errors were encountered: