@govbr-ds/release-config 2.2.0 → 2.3.0

package/README.md

@@ -8,6 +8,10 @@ Compartilhar os padrões de commit entre os projetos do [GOVBR-DS](https://gov.b
 
 ```bash
 npm install --save-dev @govbr-ds/release-config
+
+ou
+
+pnpm add -D @govbr-ds/release-config
 ```
 
 ## Plugins
@@ -50,8 +54,7 @@ module.exports = {
       {
         onSuccessTemplate: {
           username: 'Username',
-          content:
-            "A versão v$npm_package_version do projeto LOREM IPSUM já está disponível!",
+          content: 'A versão v$npm_package_version do projeto LOREM IPSUM já está disponível!',
         },
       },
     ],

package/{shared.config.js → lib/shared.config.js}

@@ -1,7 +1,7 @@
 /**
- * Arquivo com as configurações compartilhadas entre os projetos.
- * Cada projeto deve importar essa configuração e usar conforme o README.md
+ * Configurações compartilhadas do semantic-release.
  */
+
 module.exports = {
   branches: [
     'main',
@@ -42,8 +42,9 @@ module.exports = {
       {
         preset: 'conventionalcommits',
         releaseRules: [
-          // breaking precisa estar no topo devido a como o plugin se comporta: https://github.com/semantic-release/commit-analyzer#releaserules
+          // breaking precisa estar no topo: https://github.com/semantic-release/commit-analyzer#releaserules
           { breaking: true, release: 'major' },
+          { type: '*!', release: 'major' },
           { type: 'build', release: false },
           { type: 'chore', release: false },
           { type: 'ci', release: false },
@@ -73,12 +74,11 @@ module.exports = {
         presetConfig: {
           header: '# CHANGELOG',
           types: [
-            { type: 'breaking', section: '💥 BREAKING CHANGES' },
             { type: 'deprecated', section: '👎 DEPRECIADO' },
             { type: 'feat', section: '✨ NOVIDADES' },
             { type: 'removed', section: '🚧 REMOVIDO' },
             { type: 'docs', section: '📚 DOCUMENTAÇÃO' },
-            { type: 'fix', section: '🪲 CORREÇÕES' },
+            { type: 'fix', section: '🐛 CORREÇÕES' },
             { type: 'ops', section: '🔧 ATIVIDADES OPERACIONAIS' },
             { type: 'perf', section: '🚀 PERFORMANCE' },
             { type: 'refactor', section: '🔁 REFATORADO' },
@@ -95,51 +95,31 @@ module.exports = {
           noteKeywords: ['BREAKING CHANGE', 'BREAKING CHANGES', 'BREAKING'],
         },
         writerOpts: {
-          commitsSort: ['subject', 'scope'],
-          generateNotes: (commits, context) => {
-            const breakingChangesType = context.options.presetConfig.types.find(
-              (type) => type.type === 'breaking'
-            )
-
-            if (!breakingChangesType) {
-              return ''
-            }
-
-            const breakingChangesCommits = commits.filter((commit) =>
-              commit.notes?.some((note) =>
-                context.options.parserOpts.noteKeywords.some((keyword) =>
-                  note.title.includes(keyword)
-                )
-              )
-            )
-
-            if (breakingChangesCommits.length === 0) {
-              return ''
-            }
-
-            const breakingChangesSections = [
-              `## ${context.nextRelease.version} (${context.date})\n`,
-              `### ${breakingChangesType.section}\n`,
-            ]
-
-            for (const commit of breakingChangesCommits) {
-              const scope = commit.scope ? `**${commit.scope}**: ` : ''
-              const message = `${scope}${commit.header}`
-              breakingChangesSections.push(`- ${message}`)
-              if (
-                commit.notes?.some((note) =>
-                  context.options.parserOpts.noteKeywords.some((keyword) =>
-                    note.title.includes(keyword)
-                  )
-                ) &&
-                commit.body
-              ) {
-                breakingChangesSections.push(`  ${commit.body}`)
-              }
-            }
-
-            return breakingChangesSections.join('\n')
-          },
+          mainTemplate:
+            '{{> header}}\n' +
+            '\n' +
+            '{{#if noteGroups}}\n' +
+            '{{#each noteGroups}}\n' +
+            '\n' +
+            '### 💥 {{title}}\n' +
+            '\n' +
+            '{{#each notes}}\n' +
+            '* {{#if commit.scope}}**{{commit.scope}}:** {{/if}}{{text}}\n' +
+            '{{/each}}\n' +
+            '{{/each}}\n' +
+            '{{/if}}\n' +
+            '{{#each commitGroups}}\n' +
+            '\n' +
+            '{{#if title}}\n' +
+            '### {{title}}\n' +
+            '\n' +
+            '{{/if}}\n' +
+            '{{#each commits}}\n' +
+            '{{> commit root=@root}}\n' +
+            '{{/each}}\n' +
+            '\n' +
+            '{{/each}}\n',
+          commitsSort: ['scope', 'subject'],
           finalizeContext: (context) => {
             const date = new Date()
             context.date = date.toLocaleString('pt-BR', {
@@ -160,7 +140,8 @@ module.exports = {
     gitlab: [
       '@semantic-release/gitlab',
       {
-        successComment: ':tada: Issue/Merge Request incluído(a) na versão ${nextRelease.version} :tada:\n\nPara mais detalhes:\n- [GitLab release]($CI_PROJECT_URL/-/releases/${nextRelease.version})\n- [GitLab tag]($CI_PROJECT_URL/-/tags/${nextRelease.version})',
+        successComment:
+          ':tada: Issue/Merge Request incluído(a) na versão ${nextRelease.version} :tada:\n\nPara mais detalhes:\n- [GitLab release]($CI_PROJECT_URL/-/releases/${nextRelease.version})\n- [GitLab tag]($CI_PROJECT_URL/-/tags/${nextRelease.version})',
       },
     ],
     npm: ['@semantic-release/npm'],
@@ -168,10 +149,9 @@ module.exports = {
       '@semantic-release/git',
       {
         assets: ['package.json', 'CHANGELOG.md'],
-        message:  'chore(release): ${nextRelease.version} [skip ci] \n\n${nextRelease.notes} \n\nCommit gerado automaticamente durante o processo de release',
+        message:
+          'chore(release): ${nextRelease.version} [skip ci] \n\n${nextRelease.notes} \n\nCommit gerado automaticamente durante o processo de release',
       },
     ],
   },
 }
-
-

package/package.json

@@ -1,27 +1,25 @@
 {
   "name": "@govbr-ds/release-config",
-  "version": "2.2.0",
-  "description": "Configuração compartilhada do semantic-release para projetos do GovBR-DS no gitlab",
+  "version": "2.3.0",
+  "private": false,
+  "description": "Configuração compartilhada do semantic-release para projetos do GovBR-DS",
   "keywords": [
-    "gitlab",
     "govbr-ds",
-    "conventional-changelog",
-    "semantic-release",
-    "semantic-release-config"
+    "semantic-release"
   ],
   "homepage": "https://gov.br/ds/",
   "bugs": {
-    "url": "https://gitlab.com/govbr-ds/govbr-ds-release-config/issues"
+    "url": "https://gitlab.com/govbr-ds/configs/govbr-ds-release-config/issues"
   },
   "repository": {
     "type": "git",
-    "url": "git@gitlab.com:govbr-ds/govbr-ds-release-config.git"
+    "url": "git@gitlab.com:govbr-ds/configs/govbr-ds-release-config.git"
   },
   "license": "MIT",
   "author": "SERPRO <govbr-ds@serpro.gov.br> (http://serpro.gov.br/)",
-  "main": "shared.config.js",
+  "main": "lib/shared.config.js",
   "files": [
-    "shared.config.js"
+    "lib/shared.config.js"
   ],
   "scripts": {
     "commit": "git-cz",
@@ -40,20 +38,21 @@
     }
   },
   "dependencies": {
-    "@govbr-ds/release-config": "^2.1.2",
+    "@govbr-ds/release-config": "^2.2.0",
     "@semantic-release/changelog": "^6.0.3",
     "@semantic-release/git": "^10.0.1",
-    "@semantic-release/gitlab": "^12.0.4",
-    "conventional-changelog-conventionalcommits": "^6.1.0",
-    "semantic-release": "^21.0.7"
+    "@semantic-release/gitlab": "^12.0.6",
+    "conventional-changelog-conventionalcommits": "^7.0.2",
+    "js-yaml": "^4.1.0",
+    "semantic-release": "^22.0.5"
   },
   "devDependencies": {
     "@govbr-ds/commit-config": "latest",
     "git-pull-run": "^1.4.0",
     "husky": "^8.0.3",
-    "lint-staged": "^13.2.3",
-    "markdownlint-cli": "^0.35.0",
-    "prettier": "^3.0.1"
+    "lint-staged": "^15.0.1",
+    "markdownlint-cli": "^0.37.0",
+    "prettier": "^3.0.3"
   },
   "engines": {
     "node": ">=18"