How to generate note with custom sections?

[max10rogerio]

Hi, i'm trying generate release notes with custom sections, but my configuration isn't working...
I read the issues:

• How can I custom type that include in release note? #115
• Question: How to configure "angular" preset to print docs, style, etc. #77
• How to add presets to release notes? #142
• How to make changelog with specify type only? changelog#38
• https://stackoverflow.com/questions/58639452/semantic-release-release-notes-generator-how-to-teach-new-types

I don't know which setting to use

My .releaserc.json file:

{
  "branch": "master",
  "plugins": [
    [
      "@semantic-release/commit-analyzer",
      {
        "releaseRules": [
          {
            "type": "refactor",
            "release": "patch"
          },
          {
            "type": "docs",
            "release": "patch"
          },
          {
            "type": "test",
            "release": "patch"
          },
          {
            "type": "style",
            "release": "patch"
          },
          {
            "type": "perf",
            "release": "patch"
          },
          {
            "type": "build",
            "release": "patch"
          }
        ]
      }
    ],
    [
      "@semantic-release/release-notes-generator",
      {
        "writerOpts": {
          "types": [
            {
              "type": "feat",
              "section": ":sparkles: Novidades",
              "hidden": false
            },
            {
              "type": "fix",
              "section": ":bug: Correções",
              "hidden": false
            },
            {
              "type": "docs",
              "section": ":memo: Documentação",
              "hidden": false
            },
            {
              "type": "style",
              "section": ":barber: Estilização",
              "hidden": false
            },
            {
              "type": "refactor",
              "section": ":zap: Refatoração",
              "hidden": false
            },
            {
              "type": "perf",
              "section": ":fast_forward: Refatoração",
              "hidden": false
            },
            {
              "type": "test",
              "section": ":white_check_mark: Testes",
              "hidden": false
            },
            {
              "type": "chore",
              "hidden": true
            }
          ]
        }
      }
    ],
    [
      "@semantic-release/changelog",
      {
        "changelogFile": "CHANGELOG.md",
        "changelogTitle": "Notas de versão"
      }
    ],
    [
      "@semantic-release/git",
      {
        "assets": [
          "CHANGELOG.md"
        ],
        "message": "chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
      }
    ],
    [
      "@semantic-release/github",
      {
        "assets": [
          {
            "path": "server.zip",
            "label": "DeltaWeb - Build: ${nextRelease.gitTag}",
            "name": "server-${nextRelease.gitTag}.zip"
          }
        ]
      }
    ]
  ]
}

[pvdlg]

The default preset is angular and I don't think it uses the types property.
Maybe you meant to use another preset that support this property?

[max10rogerio]

Sorry, the first time I tried using presetConfig, but it wasn't working ...

Any ideia of how change the title of section commits using preset angular?

[pvdlg]

I don't think the angular preset support any option. You will have to rewrite the transform function: https://github.com/conventional-changelog/conventional-changelog/blob/79217815a7ce5f3d3f833961ce9a14bd454e5789/packages/conventional-changelog-angular/writer-opts.js#L27

[pvdlg]

Maybe you were trying to use the conventionalcommits preset that seems to support the option you are trying to use: https://github.com/conventional-changelog/conventional-changelog/blob/master/packages/conventional-changelog-conventionalcommits/writer-opts.js#L160

[max10rogerio]

Thanks!!!

After opened the PR, I read again the last note

Note: For presets that expects a configuration object, such as conventionalcommits, the presetConfig option must be set.

I changed the .releaserc.json and...

I needed to install the package: conventional-changelog-conventionalcommits and updated for:

{
  "branch": "master",
  "plugins": [
    [
      "@semantic-release/commit-analyzer",
      {
        "releaseRules": [
          {
            "type": "refactor",
            "release": "patch"
          },
          {
            "type": "docs",
            "release": "patch"
          },
          {
            "type": "test",
            "release": "patch"
          },
          {
            "type": "style",
            "release": "patch"
          },
          {
            "type": "perf",
            "release": "patch"
          },
          {
            "type": "ci",
            "release": "patch"
          },
          {
            "type": "build",
            "release": "patch"
          }
        ]
      }
    ],
    [
      "@semantic-release/release-notes-generator",
      {
        "preset": "conventionalcommits",
        "presetConfig": {
          "types": [
            {
              "type": "feat",
              "section": ":sparkles: Novidades",
              "hidden": false
            },
            {
              "type": "fix",
              "section": ":bug: Correções",
              "hidden": false
            },
            {
              "type": "docs",
              "section": ":memo: Documentação",
              "hidden": false
            },
            {
              "type": "style",
              "section": ":barber: Estilização",
              "hidden": false
            },
            {
              "type": "refactor",
              "section": ":zap: Refatoração",
              "hidden": false
            },
            {
              "type": "perf",
              "section": ":fast_forward: Desempenho",
              "hidden": false
            },
            {
              "type": "test",
              "section": ":white_check_mark: Testes",
              "hidden": false
            },
            {
              "type": "ci",
              "section": ":repeat: CI",
              "hidden": false
            },
            {
              "type": "chore",
              "hidden": true
            }
          ]
        }
      }
    ],
    [
      "@semantic-release/github",
      {
        "assets": [
          {
            "path": "server.zip",
            "label": "DeltaWeb - Build: ${nextRelease.gitTag}",
            "name": "server-${nextRelease.gitTag}.zip"
          }
        ]
      }
    ]
  ]
}

[tomavic]

This solution should be highlighted in the documentation as many issues refers to it.

[TheNotary]

True, but if you felt ignored about your opinions towards commit messages you might fare the same unwillingness to help after a long day of trying to get something working that you'd expect to have been fast and simple.

Btw, don't forget to run the below command or you'll get errors about removing the presets from the built-in libs.

npm install --save conventional-changelog

[tomavic]

Does anyone got any idea?
Still needs more explanation!

[mdrijwan]

@max10rogerio thanks man! this is brilliant!!