Настройте @semantic-release для учета коммитов «рефакторинга» в CHANGELOG.

Используя @semantic-release, я хотел бы рассмотреть изменения refactor для обоих, запуская новый релиз и записывая в файл CHANGELOG.md.

До сих пор я включал коммиты refactor в "@semantic-release/commit-analyzer", чтобы они запускали выпуск патча:

[
  "@semantic-release/commit-analyzer",
  {
    "preset": "angular",
    "releaseRules": [
      {
        "type": "refactor",
        "release": "patch"
      }
    ]
  }
],

Но эти сообщения фиксации не включены в файл CHANGELOG, как я могу настроить плагин "@semantic-release/release-notes-generator" для включения коммитов рефакторинга? Я нахожу соответствующий документ запутанным и нехваткой примеров

  1. сгенерированный пример CHANGELOG
## [0.6.4](.../compare/v0.6.3...v0.6.4) (date)

## [0.6.3](.../compare/v0.6.2...v0.6.3) (date)
  1. желаемый журнал изменений
## [0.6.4](.../compare/v0.6.3...v0.6.4) (date)

[[>>INCLUDE HERE COMMIT MSG + LINK<<]]

## [0.6.3](.../compare/v0.6.2...v0.6.3) (date)

semantic-versioning semantic-release changelog
person Manu    schedule 23.02.2021    source источник

Ответы (1)


arrow_upward
1
arrow_downward

Если кому-то это покажется полезным: нам нужно настроить "@semantic-release/release-notes-generator" для учета других ключевых слов, кроме feat и fix, включая следующие слова:

{
   "type": "refactor",
   "section": "title to be used in changelog.md",
   "hidden": false
}

Для копирования и вставки эта настройка собирает как refactor, chore, так и perf в раздел ## Internal (обратите внимание, что мне нужно было явно указать значения по умолчанию, я думаю, это потому, что он переопределяет конфигурацию)

[
  "@semantic-release/release-notes-generator",
  {
    "preset": "conventionalCommits",
    "parserOpts": {
      "noteKeywords": [
        "BREAKING CHANGE",
        "BREAKING CHANGES",
        "BREAKING"
      ]
    },
    "presetConfig": {
      "types": [
        {
          "type": "feat",
          "section": "Features"
        },
        {
          "type": "fix",
          "section": "Bug Fixes"
        },
        {
          "type": "chore",
          "section": "Internal",
          "hidden": false
        },
        {
          "type": "refactor",
          "section": "Internal",
          "hidden": false
        },
        {
          "type": "perf",
          "section": "Internal",
          "hidden": false
        }
      ]
    }
  }
]
person Manu    schedule 25.02.2021