Skip to content

Commit

Permalink
ci: include refactors and performance changes in release descriptions (
Browse files Browse the repository at this point in the history
  • Loading branch information
kmontag authored Jan 8, 2025
1 parent 7faf708 commit f3acd9c
Show file tree
Hide file tree
Showing 3 changed files with 51 additions and 4 deletions.
32 changes: 28 additions & 4 deletions .releaserc.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,40 @@ const config = {
// For defaults see:
// https://github.com/semantic-release/semantic-release/blob/master/docs/usage/configuration.md#plugins
plugins: [
// Treat refactors as patch releases. See
// https://github.com/semantic-release/commit-analyzer?tab=readme-ov-file#usage.
[
'@semantic-release/commit-analyzer',
{
preset: 'angular',
// Use conventionalcommits instead of angular, which is likely
// to become the new default at some point, and supports more
// extensive configuration. See
// https://github.com/semantic-release/semantic-release/pull/1836.
preset: 'conventionalcommits',
// Treat refactors as patch releases. See
// https://github.com/semantic-release/commit-analyzer?tab=readme-ov-file#usage.
releaseRules: [{ type: 'refactor', release: 'patch' }],
},
],
'@semantic-release/release-notes-generator',
[
'@semantic-release/release-notes-generator',
{
preset: 'conventionalcommits',
presetConfig: {
types: [
// Default sections, see https://github.com/conventional-changelog/conventional-changelog-config-spec/blob/master/versions/2.2.0/README.md#types.
{ type: 'feat', section: 'Features' },
{ type: 'fix', section: 'Bug Fixes' },
{ type: 'chore', hidden: true },
{ type: 'docs', hidden: true },
{ type: 'style', hidden: true },
{ type: 'test', hidden: true },

// Overrides for additional patch release types.
{ type: 'refactor', section: 'Refactors', hidden: false },
{ type: 'perf', section: 'Performance', hidden: false },
],
},
},
],
// Publish releases to NPM.
'@semantic-release/npm',
// Publish releases to GitHub.
Expand Down
22 changes: 22 additions & 0 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@
"@types/mocha": "^9.1.1",
"@types/tmp": "^0.2.3",
"chai": "^4.1.2",
"conventional-changelog-conventionalcommits": "^8.0.0",
"eslint": "^8.20.0",
"eslint-config-airbnb-base": "^15.0.0",
"eslint-config-prettier": "^8.5.0",
Expand Down

0 comments on commit f3acd9c

Please sign in to comment.