@govbr-ds/release-config 3.3.0-alpha.2 → 4.0.0

package/README.md

@@ -19,9 +19,9 @@ Configurações para o [Semantic Release](https://github.com/semantic-release/se
 1. Crie um arquivo `release.config.js` na raiz do seu projeto e importe os plugins que deseja usar:
 
    ```javascript
-   const { branches, commitAnalyzer, releaseNotesGenerator, changelog, gitlab, git } = require('./node_modules/@govbr-ds/config-tools/src/semantic-release.cjs')
+   import { branches, commitAnalyzer, releaseNotesGenerator, changelog, gitlab, git } from './node_modules/@govbr-ds/config-tools/src/semantic-release.cjs'
 
-   module.exports = {
+    export defaul {
      branches: branches,
      plugins: [
        commitAnalyzer,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@govbr-ds/release-config",
-  "version": "3.3.0-alpha.2",
+  "version": "4.0.0",
   "private": false,
   "description": "Configuração compartilhada do semantic-release para projetos do GovBR-DS",
   "keywords": [
@@ -13,29 +13,25 @@
   },
   "repository": {
     "type": "git",
-    "url": "git@gitlab.com:govbr-ds/tools/govbr-ds-config-tools.git"
+    "url": "git@gitlab.com:govbr-ds/tools/govbr-ds-config-tools.git",
+    "directory": "packages/release"
   },
   "license": "MIT",
   "author": "SERPRO (http://serpro.gov.br/)",
-  "main": "semantic-release.cjs",
+  "type": "module",
+  "exports": "./src/index.js",
+  "main": "./src/index.js",
   "files": [
-    "semantic-release.cjs"
+    "src"
   ],
-  "scripts": {
-    "commit": "git-cz",
-    "lint:md": "markdownlint -d --fix **/*.md"
-  },
-  "config": {
-    "commitizen": {
-      "path": "@commitlint/cz-commitlint"
-    }
-  },
   "dependencies": {
     "@semantic-release/changelog": "^6.0.3",
-    "@semantic-release/commit-analyzer": "^11.1.0",
+    "@semantic-release/commit-analyzer": "^12.0.0",
     "@semantic-release/git": "^10.0.1",
     "@semantic-release/gitlab": "^13.0.3",
-    "@semantic-release/release-notes-generator": "^12.1.0",
-    "semantic-release": "^23.0.2"
+    "@semantic-release/release-notes-generator": "^13.0.0",
+    "compare-func": "^2.0.0",
+    "inquirer": "^9.2.19",
+    "semantic-release": "^23.0.8"
   }
 }

package/{semantic-release.cjs → src/index.js}

@@ -1,3 +1,5 @@
+import { createWriterOpts } from './writer.js'
+
 const branches = [
   'main',
   '+([0-9])?(.{+([0-9]),x}).x', //1.x.x
@@ -68,17 +70,7 @@ const releaseNotesGenerator = [
     parserOpts: {
       noteKeywords: ['BREAKING CHANGE', 'BREAKING CHANGES', 'BREAKING'],
     },
-    writerOpts: {
-      commitsSort: ['scope', 'subject'],
-      finalizeContext: (context) => {
-        const date = new Date()
-        context.date = date.toLocaleString('pt-BR', {
-          timeZone: 'America/Sao_Paulo',
-          dateStyle: 'short',
-        })
-        return context
-      },
-    },
+    writerOpts: await createWriterOpts(),
   },
 ]
 
@@ -94,6 +86,10 @@ const 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})',
+    failComment:
+      'A release a partir da branch ${branch.name} falhou devido aos seguintes erros:\n- ${errors.map(err => err.message).join("\\n- ")}',
+    failTitle: 'A release automática falhou 🚨',
+    labels: 'crítico, precisa-de-triagem, semantic-release',
   },
 ]
 
@@ -106,4 +102,4 @@ const git = [
   },
 ]
 
-module.exports = { branches, commitAnalyzer, releaseNotesGenerator, changelog, gitlab, git }
+export { branches, changelog, commitAnalyzer, git, gitlab, releaseNotesGenerator }

package/src/templates/commit.hbs

@@ -0,0 +1,29 @@
+*{{#if scope}} **{{scope}}:**
+{{~/if}} {{#if subject}}
+  {{~subject}}
+{{~else}}
+  {{~header}}
+{{~/if}}
+
+{{~!-- commit link --}}{{~#if hash}} {{#if @root.linkReferences~}}
+    ([{{shortHash}}]({{commitUrlFormat}}))
+  {{~else}}
+    {{~shortHash}}
+  {{~/if}}{{~/if}}
+
+{{~!-- commit references --}}
+{{~#if references~}}
+  , closes
+  {{~#each references}} {{#if @root.linkReferences~}}
+      [
+      {{~#if this.owner}}
+        {{~this.owner}}/
+      {{~/if}}
+      {{~this.repository}}{{this.prefix}}{{this.issue}}]({{issueUrlFormat}})
+    {{~else}}
+      {{~#if this.owner}}
+        {{~this.owner}}/
+      {{~/if}}
+      {{~this.repository}}{{this.prefix}}{{this.issue}}
+    {{~/if}}{{/each}}
+{{~/if}}

package/src/templates/header.hbs

@@ -0,0 +1,9 @@
+## {{#if @root.linkCompare~}}
+  [{{version}}]({{compareUrlFormat}})
+{{~else}}
+  {{~version}}
+{{~/if}}
+{{~#if title}} "{{title}}"
+{{~/if}}
+{{~#if date}} ({{date}})
+{{/if}}

package/src/templates/template.hbs

@@ -0,0 +1,22 @@
+{{> header}}
+
+{{#if noteGroups}}
+{{#each noteGroups}}
+### 💥 {{title}}
+
+{{#each notes}}
+  * {{#if commit.scope}}**{{commit.scope}}:** {{/if}}{{text}}
+{{/each}}
+{{/each}}
+{{/if}}
+{{#each commitGroups}}
+
+{{#if title}}
+### {{title}}
+
+{{/if}}
+{{#each commits}}
+  {{> commit root=@root}}
+
+{{/each}}
+{{/each}}

package/src/writer.js

@@ -0,0 +1,39 @@
+import compareFunc from 'compare-func'
+import { readFile } from 'fs/promises'
+import { resolve } from 'path'
+import { fileURLToPath } from 'url'
+
+const dirname = fileURLToPath(new URL('.', import.meta.url))
+
+export async function createWriterOpts() {
+  const [template, header, commit, footer] = await Promise.all([
+    readFile(resolve(dirname, './templates/template.hbs'), 'utf-8'),
+    readFile(resolve(dirname, './templates/header.hbs'), 'utf-8'),
+    readFile(resolve(dirname, './templates/commit.hbs'), 'utf-8'),
+    readFile(resolve(dirname, './templates/footer.hbs'), 'utf-8'),
+  ])
+  const writerOpts = getWriterOpts()
+
+  writerOpts.mainTemplate = template
+  writerOpts.headerPartial = header
+  writerOpts.commitPartial = commit
+  writerOpts.footerPartial = footer
+
+  return writerOpts
+}
+
+function getWriterOpts() {
+  return {
+    groupBy: 'type',
+    commitsSort: ['scope', 'subject', 'header'],
+    finalizeContext: (context) => {
+      const date = new Date()
+      context.date = date.toLocaleString('pt-BR', {
+        timeZone: 'America/Sao_Paulo',
+        dateStyle: 'short',
+      })
+      return context
+    },
+    notesSort: compareFunc,
+  }
+}