Skip to content

Commit 7acc267

Browse files
authored
chore(publish): Add auto changelog generation (#854)
* chore(repo): Add auto changelog generation * remove release.md
1 parent 7ea6848 commit 7acc267

File tree

5 files changed

+6
-58
lines changed

5 files changed

+6
-58
lines changed

.craft.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
github:
22
owner: getsentry
33
repo: sentry-javascript-bundler-plugins
4-
changelogPolicy: simple
4+
changelog:
5+
policy: auto
56
preReleaseCommand: bash scripts/craft-pre-release.sh
67
requireNames:
78
- /^sentry-bundler-plugin-core-.*\.tgz$/

CONTRIBUTING.md

Lines changed: 4 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -73,18 +73,7 @@ Our different types of reviews:
7373
_These steps are only relevant to Sentry employees when preparing and publishing a new SDK release._
7474

7575
1. Determine what version will be released (we use [semver](https://semver.org)).
76-
2. Update [`CHANGELOG.md`](https://github.com/getsentry/sentry-javascript-bundler-plugins/edit/master/CHANGELOG.md) to add an entry for the next release number and a list of changes since the last release. (See details below.)
77-
3. Run the [Prepare Release](https://github.com/getsentry/sentry-javascript-bundler-plugins/actions/workflows/release.yml) workflow.
78-
4. A new issue should appear in https://github.com/getsentry/publish/issues.
79-
5. Ask a member of the [@getsentry/releases team](https://github.com/orgs/getsentry/teams/releases/members) to approve the release.
80-
81-
### Updating the Changelog
82-
83-
1. Create a new branch.
84-
2. Run `yarn changelog` and copy all commits in the list.
85-
3. Create a new section in the changelog, deciding based on the changes whether it should be a minor bump or a patch release.
86-
4. Paste in the commits you copied earlier.
87-
5. Delete any which aren't user-facing changes.
88-
6. Alphabetize the rest.
89-
7. If any of the PRs are from external contributors, include underneath the commits `Work in this release contributed by <list of external contributors' GitHub usernames>. Thank you for your contributions!`. If there's only one external PR, don't forget to remove the final `s`. If there are three or more, use an Oxford comma. (It's in the Sentry styleguide!)
90-
8. Commit, push, and open a PR against `main` with the title `meta: Update changelog for <fill in relevant version here>`.
76+
2. Run the [Prepare Release](https://github.com/getsentry/sentry-javascript-bundler-plugins/actions/workflows/release.yml) workflow.
77+
3. A new issue should appear in https://github.com/getsentry/publish/issues.
78+
4. At this point, you can review the new changelog entry on the `relase/<version>` branch and make adjustments if necessary.
79+
5. Start the release by adding the approval label on the publish issue

RELEASE.md

Lines changed: 0 additions & 5 deletions
This file was deleted.

package.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@
1313
"build:watch": "nx run-many --target=build:watch --all",
1414
"build:graph": "nx graph",
1515
"build:npm": "nx run-many --target=build:npm --all",
16-
"changelog": "ts-node ./scripts/get-commit-list.ts",
1716
"check:types": "nx run-many --target=check:types --all",
1817
"clean": "nx run-many --target=clean --all",
1918
"clean:all": "nx run-many --target=clean:all --all && yarn",

scripts/get-commit-list.ts

Lines changed: 0 additions & 36 deletions
This file was deleted.

0 commit comments

Comments
 (0)