@govbr-ds/release-config 4.6.0 → 5.0.0

package/README.md

@@ -1,8 +1,10 @@
-# GovBR-DS - Config Tools
+# GovBR-DS - Release Config
 
 ## Objetivo
 
-Compartilhar os padrões de geração de release entre os projetos do [GovBR-DS](https://gitlab.com/govbr-ds 'GovBR-DS').
+Compartilhar a política de versionamento, changelog e publicação entre os projetos do [GovBR-DS](https://gitlab.com/govbr-ds 'GovBR-DS').
+
+O pacote fornece a configuração comum do Semantic Release. Ele não executa comandos específicos de Nx, não escolhe o registry do consumidor e não publica mensagens em serviços externos por conta própria.
 
 ## Como instalar
 
@@ -16,25 +18,94 @@ Configurações para o [Semantic Release](https://github.com/semantic-release/se
 
 ## Como configurar
 
-1. Crie um arquivo `release.config.js` na raiz do seu projeto e importe os plugins que deseja usar:
+1. Crie um arquivo `release.config.js` na raiz do seu projeto e importe a configuração base:
 
    ```javascript
-   import { branches, commitAnalyzer, releaseNotesGenerator, changelog, gitlab, git } from './node_modules/@govbr-ds/config-tools/src/semantic-release.cjs'
-
-    export default {
-     branches: branches,
-     plugins: [
-       commitAnalyzer,
-       releaseNotesGenerator,
-       changelog,
-       gitlab,
-       git,
-       ...
-     ],
+   import releaseConfig from '@govbr-ds/release-config'
+
+   export default releaseConfig
+   ```
+
+   Para adicionar ou sobrescrever alguma configuração, crie uma cópia da configuração base:
+
+   ```javascript
+   import releaseConfig from '@govbr-ds/release-config'
+
+   export default {
+     ...releaseConfig,
+     plugins: [...releaseConfig.plugins, '@semantic-release/npm'],
    }
    ```
 
-   Para sobrescrever alguma configuração siga o padrão do [Semantic Release](https://github.com/semantic-release/semantic-release). A ordem definida será a ordem de execução!
+   Para configurações específicas de monorepos Nx, componha os plugins base com o fluxo Nx no projeto consumidor. A configuração publicada não executa comandos Nx por conta própria.
+
+   A ordem dos plugins define a ordem de execução dentro de cada etapa do [Semantic Release](https://github.com/semantic-release/semantic-release).
+
+## Política de versionamento
+
+O Semantic Release calcula a próxima versão a partir dos commits desde a última tag:
+
+| Tipo       | Uso                                                | Versão padrão |
+| ---------- | -------------------------------------------------- | ------------- |
+| `feat`     | Nova capacidade compatível com a API existente     | `minor`       |
+| `fix`      | Correção de comportamento                          | `patch`       |
+| `docs`     | Atualização de documentação ou exemplos            | `patch`       |
+| `perf`     | Melhoria de desempenho sem quebra de API           | `patch`       |
+| `refactor` | Reorganização interna sem mudança de comportamento | `patch`       |
+| `removed`  | Remoção de API ou recurso público                  | `major`       |
+| `revert`   | Reversão de uma mudança publicada                  | `minor`       |
+
+Os tipos `build`, `chore`, `ci`, `lint`, `ops`, `test`, `wip` e `site` são aceitos para manter o histórico consistente, mas não geram release automaticamente. `deprecated` aparece no changelog, porém também não gera versão por si só.
+
+Uma mudança incompatível deve ser marcada como breaking change. Ela gera `major` independentemente do tipo:
+
+```text
+feat(api)!: alterar contrato de autenticação
+
+BREAKING CHANGE: o campo token agora é obrigatório e precisa ser enviado no cabeçalho Authorization.
+```
+
+O escopo identifica a área alterada, não o impacto da versão:
+
+```text
+fix(button): corrigir foco após o clique
+feat(tokens): adicionar cor semântica de informação
+```
+
+Não use `minor` ou `patch` como escopo para forçar uma versão. O impacto deve ser expresso pelo tipo ou por uma breaking change.
+
+## Estrutura para monorepos Nx
+
+O pacote exporta `basePlugins` para que o projeto consumidor acrescente seu próprio fluxo de preparação e publicação:
+
+```javascript
+import { basePlugins, branches } from '@govbr-ds/release-config'
+
+export default {
+  branches,
+  plugins: [
+    ...basePlugins,
+    // Plugins específicos do monorepo entram aqui.
+  ],
+}
+```
+
+Isso mantém a configuração publicada independente de Nx e evita que um projeto simples instale ou execute ferramentas que não utiliza.
+
+## Validação local
+
+Antes de publicar uma release, valide a configuração sem executar `prepare`, `publish` ou notificações:
+
+```bash
+pnpm exec semantic-release --dry-run
+```
+
+No CI, use o lockfile congelado e a versão instalada no projeto:
+
+```bash
+pnpm install --frozen-lockfile
+pnpm exec semantic-release
+```
 
 ## Method Date.prototype.toString called on incompatible receiver
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@govbr-ds/release-config",
-  "version": "4.6.0",
+  "version": "5.0.0",
   "private": false,
   "description": "Configuração compartilhada do semantic-release para projetos do GovBR-DS",
   "keywords": [
@@ -18,6 +18,9 @@
   },
   "license": "MIT",
   "author": "SERPRO (http://serpro.gov.br/)",
+  "publishConfig": {
+    "access": "public"
+  },
   "type": "module",
   "exports": "./src/index.js",
   "main": "./src/index.js",
@@ -25,10 +28,13 @@
     "src"
   ],
   "dependencies": {
+    "@govbr-ds/commit-types": "5.0.0",
     "@semantic-release/changelog": "^6.0.3",
+    "@semantic-release/commit-analyzer": "^13.0.1",
     "@semantic-release/git": "^10.0.1",
-    "@semantic-release/gitlab": "^13.2.6",
-    "conventional-changelog-conventionalcommits": "9.1.0",
-    "semantic-release": "^24.2.7"
+    "@semantic-release/gitlab": "^13.3.3",
+    "@semantic-release/release-notes-generator": "^14.1.1",
+    "conventional-changelog-conventionalcommits": "10.2.1",
+    "semantic-release": "^25.0.7"
   }
 }

package/src/index.js

@@ -1,3 +1,9 @@
+import commitTypesModule from '@govbr-ds/commit-types'
+
+const { commitTypes } = commitTypesModule
+
+// Branches that receive stable releases, maintenance releases or prereleases.
+// Keep this list aligned with the branches protected by the consumer's CI.
 const branches = [
   'main',
   '+([0-9])?(.{+([0-9]),x}).x', //1.x.x
@@ -11,54 +17,32 @@ const branches = [
   // { name: 'rc', prerelease: true },
 ]
 
-const types = [
-  { type: 'deprecated', section: '👎 DEPRECIADO' },
-  { type: 'feat', section: '✨ NOVIDADES' },
-  { type: 'removed', section: '🚧 REMOVIDO' },
-  { type: 'docs', section: '📚 DOCUMENTAÇÃO' },
-  { type: 'fix', section: '🐛 CORREÇÕES' },
-  { type: 'ops', section: '🔧 ATIVIDADES OPERACIONAIS' },
-  { type: 'perf', section: '🚀 PERFORMANCE' },
-  { type: 'refactor', section: '🔁 REFATORADO' },
-  { type: 'revert', section: '⏪ REVERTIDO' },
-  { type: 'build', hidden: true },
-  { type: 'chore', hidden: true },
-  { type: 'ci', hidden: true },
-  { type: 'lint', hidden: true },
-  { type: 'test', hidden: true },
-  { type: 'wip', hidden: true },
-  { type: 'site', hidden: true },
-  { type: 'bump', section: '🆙 Bump' },
-]
+// Types shown in generated changelogs. Types marked as hidden remain valid in
+// commits but are omitted from release notes because they are implementation
+// or maintenance details.
+const types = commitTypes.map(({ value, changelog }) => ({
+  type: value,
+  ...(changelog ? { section: changelog.title } : { hidden: true }),
+}))
+
+const releaseRules = commitTypes.map(({ value, semverBump }) => ({
+  type: value,
+  release: semverBump === 'none' ? false : semverBump,
+}))
 
 const commitAnalyzer = [
   '@semantic-release/commit-analyzer',
   {
     preset: 'conventionalcommits',
     releaseRules: [
+      // Uma mudança incompatível (breaking change) sempre tem prioridade sobre o tipo do commit e gera uma versão major.
       { breaking: true, release: 'major' },
-      { scope: 'minor', release: 'minor' },
+      { type: '*!', release: 'major' },
+      // Estes escopos são exclusões explícitas para alterações que não devem gerar publicação.
       { scope: 'monorepo', release: false },
       { scope: 'no-release', release: false },
-      { scope: 'patch', release: 'patch' },
       { scope: 'site', release: false },
-      { type: '*!', release: 'major' },
-      { type: 'build', release: false },
-      { type: 'bump', release: 'minor' },
-      { type: 'chore', release: false },
-      { type: 'ci', release: false },
-      { type: 'deprecated', release: false },
-      { type: 'docs', release: 'patch' },
-      { type: 'feat', release: 'minor' },
-      { type: 'fix', release: 'patch' },
-      { type: 'lint', release: false },
-      { type: 'ops', release: false },
-      { type: 'perf', release: 'patch' },
-      { type: 'refactor', release: 'patch' },
-      { type: 'removed', release: 'minor' },
-      { type: 'revert', release: 'minor' },
-      { type: 'test', release: false },
-      { type: 'wip', release: false },
+      ...releaseRules,
     ],
     parserOpts: {
       noteKeywords: ['BREAKING CHANGE', 'BREAKING CHANGES', 'BREAKING'],
@@ -195,10 +179,18 @@ const gitlab = [
 const git = [
   '@semantic-release/git',
   {
-    assets: ['package.json'],
+    assets: ['package.json', 'CHANGELOG.md'],
     message:
       'chore(release): v${nextRelease.version} [skip ci] \n\n${nextRelease.notes} \n\nCommit gerado automaticamente durante o processo de release',
   },
 ]
 
-export { branches, changelog, commitAnalyzer, git, gitlab, releaseNotesGenerator }
+const basePlugins = [commitAnalyzer, releaseNotesGenerator, changelog, gitlab]
+
+const releaseConfig = {
+  branches,
+  plugins: [...basePlugins, git],
+}
+
+export { basePlugins, branches, changelog, commitAnalyzer, git, gitlab, releaseConfig, releaseNotesGenerator }
+export default releaseConfig