変更履歴自動生成ツールの調査と紹介

$ cat pyproject.toml
[tool.poetry]
name = "changelog-sample"
version = "0.0.0"
description = "changelog sample"
authors = ["xxx"]
license = "MIT"
readme = "README.md"
packages = [
    {include = "changelog_sample", from = "src"}
]

[tool.poetry.build]
generate-setup-file = false

[tool.poetry.dependencies]
python = "^3.10"

[tool.poetry.group.dev.dependencies]
commitizen = "^2.42.1"
commitizen-cz-custom-commits = {path = "../commitizen-cz-custom-commits", develop = true}

[build-system]
requires = ["poetry-core>=1.0.0"]
build-backend = "poetry.core.masonry.api"

[tool.commitizen]
name = "cz_custom_commits" # コミットルール名(デフォルト：cz_conventional_commits)
version = "0.0.0"
version_files = [
    "pyproject.toml:version"
]
tag_format = "v$version"
update_changelog_on_bump = true
bump_message = "chore: bump from $current_version to $new_version"
changelog_file = "CHANGELOG_cz.md"
# major_version_zero = true # for initial development
github_repo_owner = "<GitHubアカウントID>"
github_repo_name = "changelog-sample"

$ poetry run cz --help
usage: cz [-h] [--debug] [-n NAME] [-nr NO_RAISE] {init,commit,c,ls,example,info,schema,bump,changelog,ch,check,version} ...

Commitizen is a cli tool to generate conventional commits.
For more information about the topic go to https://conventionalcommits.org/

options:
  -h, --help            show this help message and exit
  --debug               use debug mode
  -n NAME, --name NAME  use the given commitizen (default: cz_conventional_commits)
  -nr NO_RAISE, --no-raise NO_RAISE
                        comma separated error codes that will not rise error, e.g: cz -nr 1,2,3 bump. See codes at https://commitizen-tools.github.io/commitizen/exit_codes/

commands:
  {init,commit,c,ls,example,info,schema,bump,changelog,ch,check,version}
    init                init commitizen configuration
    commit (c)          create new commit
    ls                  show available commitizens
    example             show commit example
    info                show information about the cz
    schema              show commit schema
    bump                bump semantic version based on the git log
    changelog (ch)      generate changelog (note that it will overwrite existing file)
    check               validates that a commit message matches the commitizen schema
    version             get the version of the installed commitizen or the current project (default: installed commitizen)

$ poetry run cz bump --help
usage: cz bump [-h] [--dry-run] [--files-only] [--local-version] [--changelog] [--no-verify] [--yes] [--tag-format TAG_FORMAT] [--bump-message BUMP_MESSAGE] [--prerelease {alpha,beta,rc}]
               [--devrelease DEVRELEASE] [--increment {MAJOR,MINOR,PATCH}] [--check-consistency] [--annotated-tag] [--gpg-sign] [--changelog-to-stdout] [--retry] [--major-version-zero]
               [--prerelease-offset PRERELEASE_OFFSET]
               [MANUAL_VERSION]

positional arguments:
  MANUAL_VERSION        bump to the given version (e.g: 1.5.3)

options:
  -h, --help            show this help message and exit
  --dry-run             show output to stdout, no commit, no modified files
  --files-only          bump version in the files from the config
  --local-version       bump only the local version portion
  --changelog, -ch      generate the changelog for the newest version
  --no-verify           this option bypasses the pre-commit and commit-msg hooks
  --yes                 accept automatically questions done
  --tag-format TAG_FORMAT
                        the format used to tag the commit and read it, use it in existing projects, wrap around simple quotes
  --bump-message BUMP_MESSAGE
                        template used to create the release commit, useful when working with CI
  --prerelease {alpha,beta,rc}, -pr {alpha,beta,rc}
                        choose type of prerelease
  --devrelease DEVRELEASE, -d DEVRELEASE
                        specify non-negative integer for dev. release
  --increment {MAJOR,MINOR,PATCH}
                        manually specify the desired increment
  --check-consistency, -cc
                        check consistency among versions defined in commitizen configuration and version_files
  --annotated-tag, -at  create annotated tag instead of lightweight one
  --gpg-sign, -s        sign tag instead of lightweight one
  --changelog-to-stdout
                        Output changelog to the stdout
  --retry               retry commit if it fails the 1st time
  --major-version-zero  keep major version at zero, even for breaking changes
  --prerelease-offset PRERELEASE_OFFSET
                        start pre-releases with this offset

$ poetry run cz changelog --help
usage: cz changelog [-h] [--dry-run] [--file-name FILE_NAME] [--unreleased-version UNRELEASED_VERSION] [--incremental] [--start-rev START_REV] [rev_range]

positional arguments:
  rev_range             generates changelog for the given version (e.g: 1.5.3) or version range (e.g: 1.5.3..1.7.9)

options:
  -h, --help            show this help message and exit
  --dry-run             show changelog to stdout
  --file-name FILE_NAME
                        file name of changelog (default: 'CHANGELOG.md')
  --unreleased-version UNRELEASED_VERSION
                        set the value for the new version (use the tag value), instead of using unreleased
  --incremental         generates changelog from last created version, useful if the changelog has been manually modified
  --start-rev START_REV
                        start rev of the changelog.If not set, it will generate changelog from the start

$ cat pyproject.toml
[tool.poetry]
name = "changelog-sample"
version = "0.0.0"
description = "changelog sample"
authors = ["xxx"]
license = "MIT"
readme = "README.md"
packages = [
    {include = "changelog_sample", from = "src"}
]

[tool.poetry.build]
generate-setup-file = false

[tool.poetry.dependencies]
python = "^3.10"

[tool.poetry.group.dev.dependencies]
python-semantic-release = "^7.33.2"

[build-system]
requires = ["poetry-core>=1.0.0"]
build-backend = "poetry.core.masonry.api"

[tool.semantic_release]
branch = "main"
version_toml = [
    "pyproject.toml:tool.poetry.version",
    "pyproject.toml:tool.commitizen.version"
]
version_source = "commit"
# major_on_zero = true # for initial development
commit_subject = "chore: bump to {version}"
commit_message = ""
commit_author = "semantic-release <noreply@github.com>" # this is author, but not comitter
changelog_sections = "breaking, feature, fix, performance"
changelog_components = "semantic_release.changelog.changelog_headers,semantic_release.changelog.compare_url"
changelog_file = "CHANGELOG_sr.md"
upload_to_repository = false # upload distributions to pypi repository
upload_to_release = false # upload distributions to GitHub releases
tag_format = "v{version}"

$ poetry run semantic-release --help
Usage: semantic-release [OPTIONS] COMMAND [ARGS]...

Options:
  -v, --verbosity LVL             Either CRITICAL, ERROR, WARNING, INFO or
                                  DEBUG
  --major                         Force major version.
  --minor                         Force minor version.
  --patch                         Force patch version.
  --prerelease                    Creates a prerelease version.
  --prerelease-patch / --no-prerelease-patch
                                  whether or not prerelease always gets at
                                  least a patch-level bump  [default:
                                  prerelease-patch]
  --post                          Post changelog.
  --retry                         Retry the same release, do not bump.
  --noop                          No-operations mode, finds the new version
                                  number without changing it.
  -D, --define TEXT               setting="value", override a configuration
                                  value.
  --help                          Show this message and exit.

Commands:
  changelog      Generate the changelog since the last release.
  print-version  Print the current or new version to standard output.
  publish        Run the version task, then push to git and upload to an...
  version        Detect the new version according to git log and semver.

$ poetry run semantic-release version --help
Usage: semantic-release version [OPTIONS]

  Detect the new version according to git log and semver.

  Write the new version number and commit it, unless the noop option is True.

Options:
  -v, --verbosity LVL             Either CRITICAL, ERROR, WARNING, INFO or
                                  DEBUG
  --major                         Force major version.
  --minor                         Force minor version.
  --patch                         Force patch version.
  --prerelease                    Creates a prerelease version.
  --prerelease-patch / --no-prerelease-patch
                                  whether or not prerelease always gets at
                                  least a patch-level bump  [default:
                                  prerelease-patch]
  --post                          Post changelog.
  --retry                         Retry the same release, do not bump.
  --noop                          No-operations mode, finds the new version
                                  number without changing it.
  -D, --define TEXT               setting="value", override a configuration
                                  value.
  --help                          Show this message and exit.

$ poetry run semantic-release changelog --help
Usage: semantic-release changelog [OPTIONS]

  Generate the changelog since the last release.

  :raises ImproperConfigurationError: if there is no current version

Options:
  -v, --verbosity LVL             Either CRITICAL, ERROR, WARNING, INFO or
                                  DEBUG
  --major                         Force major version.
  --minor                         Force minor version.
  --patch                         Force patch version.
  --prerelease                    Creates a prerelease version.
  --prerelease-patch / --no-prerelease-patch
                                  whether or not prerelease always gets at
                                  least a patch-level bump  [default:
                                  prerelease-patch]
  --post                          Post changelog.
  --retry                         Retry the same release, do not bump.
  --noop                          No-operations mode, finds the new version
                                  number without changing it.
  -D, --define TEXT               setting="value", override a configuration
                                  value.
  --unreleased / --released       Decides whether to show the released or
                                  unreleased changelog.
  --help                          Show this message and exit.

$ poetry run semantic-release publish --help
Usage: semantic-release publish [OPTIONS]

  Run the version task, then push to git and upload to an artifact repository
  / GitHub Releases.

Options:
  -v, --verbosity LVL             Either CRITICAL, ERROR, WARNING, INFO or
                                  DEBUG
  --major                         Force major version.
  --minor                         Force minor version.
  --patch                         Force patch version.
  --prerelease                    Creates a prerelease version.
  --prerelease-patch / --no-prerelease-patch
                                  whether or not prerelease always gets at
                                  least a patch-level bump  [default:
                                  prerelease-patch]
  --post                          Post changelog.
  --retry                         Retry the same release, do not bump.
  --noop                          No-operations mode, finds the new version
                                  number without changing it.
  -D, --define TEXT               setting="value", override a configuration
                                  value.
  --help                          Show this message and exit.

$ cat package.json
{
  "version": "0.0.0",
  "scripts": {
    "version": "conventional-changelog --preset angular --release-count 0 --tag-prefix v --pkg package.json --infile CHANGELOG_cc.md --same-file && git add CHANGELOG_cc.md"
  },
  "dependencies": {
    "conventional-changelog-cli": "^2.2.2"
  }
}

$ npm version --help
Bump a package version

Usage:
npm version [<newversion> | major | minor | patch | premajor | preminor | prepatch | prerelease | from-git]

Options:
[--allow-same-version] [--no-commit-hooks] [--no-git-tag-version] [--json]
[--preid prerelease-id] [--sign-git-tag]
[-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
[-ws|--workspaces] [--no-workspaces-update] [--include-workspace-root]

alias: verison

Run "npm help version" for more info

$ conventional-changelog --help

  Generate a changelog from git metadata

  Usage
    conventional-changelog

  Example
    conventional-changelog -i CHANGELOG.md --same-file

  Options
    -i, --infile              Read the CHANGELOG from this file

    -o, --outfile             Write the CHANGELOG to this file
                              If unspecified, it prints to stdout

    -s, --same-file           Outputting to the infile so you do not need to specify the same file as outfile

    -p, --preset              Name of the preset you want to use. Must be one of the following:
                              angular, atom, codemirror, conventionalcommits, ember, eslint, express, jquery or jshint

    -k, --pkg                 A filepath of where your package.json is located
                              Default is the closest package.json from cwd

    -a, --append              Should the newer release be appended to the older release
                              Default: false

    -r, --release-count       How many releases to be generated from the latest
                              If 0, the whole changelog will be regenerated and the outfile will be overwritten
                              Default: 1

    --skip-unstable           If given, unstable tags will be skipped, e.g., x.x.x-alpha.1, x.x.x-rc.2

    -u, --output-unreleased   Output unreleased changelog

    -v, --verbose             Verbose output. Use this for debugging
                              Default: false

    -n, --config              A filepath of your config script
                              Example of a config script: https://github.com/conventional-changelog/conventional-changelog/blob/master/packages/conventional-changelog-cli/test/fixtures/config.js

    -c, --context             A filepath of a json that is used to define template variables
    -l, --lerna-package       Generate a changelog for a specific lerna package (:pkg-name@1.0.0)
    -t, --tag-prefix          Tag prefix to consider when reading the tags
    --commit-path             Generate a changelog scoped to a specific directory