Skip to content

Latest commit

 

History

History
587 lines (359 loc) · 32.1 KB

CHANGELOG.md

File metadata and controls

587 lines (359 loc) · 32.1 KB
Raw

CHANGELOG
rivy-go/git-changelog

This project adheres to Semantic Versioning.
The changelog format is based on Keep a Changelog using conventional/semantic commits.

1.2.0 (2024-04-24)

[1.2.0; details]

Changes

  • change ~ add disabled code to presort commits with ToDOs ∾ 7e0e45a
  • change ~ use stable sorts enabling final output consistency/stability ∾ afe58e0
  • change ~ add bmp config (better version control/consistency) ∾ b2025e0
  • change ~ add available detail to version (improves precision of version) ∾ 866828c

Documentation

  • docs ~ (README) remove broken badges ∾ eb00b20
  • docs ~ (README) add installation notes ∾ 975ff94
  • docs ~ (CHANGELOG) update after template and stable sort changes ∾ 443be70
  • docs ~ polish commentary ∾ f5af65e
  • docs ~ (README) correct/revise install instructions ∾ 5c594cd
  • docs (spell): fix spelling errors ∾ a2c0c42

Maintenance

  • maint (build): (Makefile) update (v2024.04.21); multiple changes ∾ f995f0b
  • maint (build): (Makefile) update to v2024.04.09 ∾ 6a6b2bf
  • maint (build): (Makefile) fix/improve/refactor ∾ dfde77f
  • maint (build): CHANGELOG template changes ∾ 36171bb
  • maint (dev): fix CHANGELOG template for no commits in range ∾ af7e509
  • maint (dev): (Makefile) update for fixes (v2024-04-10) ∾ 738505d
  • maint (dev): (gitignore) add possible alternate build directories ∾ 37379ad

1.1.0 (2021-02-13)

[1.1.0; details]

Changes

  • add '--next-tag-now' CLI option ∾ e3a58a0
  • add 'Separator' field to Commit structure ∾ 8d80c49
  • add 'smartLowerFirstWord' template function ∾ 09fd4e5
  • change ~ improve 'upperFirst' to effect first non-space character ∾ c47dac0

Maintenance

  • maint (build): VSCode configuration update ∾ 1e47489
  • maint (deps): go mod tidy ∾ 530970c
  • maint (dev): update VSCode settings ∾ 1316480
  • maint (dev): (gitignore) ignore file history storage ∾ 340ac99
  • maint (dev): update .editorconfig ∾ 39e1f48
  • maint (polish): make format (ie, go fmt) whitespace standardization ∾ e8e9894
  • maint (polish): whitespace fixup ∾ dde4272

Refactoring

  • refactor (polish): fix CMD lint warnings (function exports and comments) ∾ 1ce091a

1.0.0 (2020-04-18)

FORK! ~ project hard forked from git-chglog/git-chglog

  • git-changelog
  • added features
    • allows multiple possible header pattern matches
    • Commit.Type mapping/aggregation
    • add 'commitURL' template function
    • add 'unreleased' CLI flag (and now default to skipping unreleased commits)
    • allow zero tag/version matches without error
    • add Tag.Pattern as config-file option for --tag-filter-pattern
  • modernize build methods and improve platform portability of builds
  • improve code structure for better separation of concerns

.# [why]

This feature expansion was offered to the original project without response. So, in order to add the needed new features, as well as modernize build methods and code structure, a hard fork was created and the utility renamed to git-changelog.

To expound on the newly added features:

  1. Multiple header pattern regex are allowed as an alternation with first matching.
    • this is useful to allow for mixed-commit message type repositories (especially those repositories which have multiple styles or are "in-transition" to a new style)
  2. Adds Commit.Type mapping/aggregation (eg, 'add' => 'change', 'added' => 'change', etc).
    • useful for repositories with mixed-commit message formats
    • can aggregate different commit-types into a single category
    • uses "smart-case" matching which can be used to ignore case of commit-type (eg, change: change will match any case-variant of "change" [eg, "CHANGE', "Change", etc)
  3. Adds a commitURL() template function which can map hashes to a repository-style URL.
    • useful for sub-templating individual commit formats
  4. Adds a command-line option to control display of "unreleased" commits.
    • useful for generating the changelog automatically for automated builds
    • change the default to not show "unreleased" commits as that would be the most used case
      • also, adds -u to the command line options to easily process and display unreleased commits
  5. Allows empty tags/versions without error if no query string is used.
    • useful for initial repositories without any tags and for unmatched tag/version patterns
    • still an error if a query is passed and no match is found
  6. Adds a corresponding config file entry for the --tag-filter-pattern CLI option.
    • configuration file entries, as usual, will be overridden by the CLI option, if used
[1.0.0; details]

Features

  • feat: add option to filter commits in a case insensitive way ∾ 72fb3ea
  • feat: add upperFirst template function ∾ 495fa2d
  • feat: Add emoji format and some formatters in variables ∾ 15ce9db
  • feat: allow zero tags/versions without error ∾ d634b33
  • feat: add commitURL() template function ∾ c2302b5
  • feat: add commit type mapping ∾ 12b2197
  • feat: add support for multiple alternate header regexs ∾ acd99ef
  • feat: add Tag.Pattern as config-file option ∾ 019a134
  • feat (API!): add 'unreleased' CLI flag (and now default to skipping unreleased commits) ∾ fcb25bf

Changes

  • change (FORK!): FORK project (from 'git-chglog/git-chglog' to 'rivy-go/git-changelog'); now git-changelog ∾ abbd1b6

Documentation

  • docs ~ de-lint and polish README ∾ 27367a9
  • docs ~ update project CHANGELOG auto-generator configuration (via git-chglog) ∾ 1f89ae0
  • docs: Markdown tweaks in README.md ∾ ec5cdfe
  • docs: Update CHANGELOG ∾ 6050f20
  • docs (polish): README whitespace cleanup ∾ 26b5bf7

Maintenance

  • build ~ configure VSCode debugging of CLI ∾ 5e5e4ba
  • maint ~ update git-chglog configuration ∾ 7b926be
  • maint ~ FIXME/broken test ∾ 735e907
  • maint (build): re-vendor dependencies (via go mod vendor) ∾ 3036c56
  • maint (build): convert project from using dep to Go Modules for dependencies ∾ 41ffd9a
  • maint (build): add 'format' and 'lint' Makefile targets (code hygiene helpers) ∾ f7968be
  • maint (build): convert to a cross-platform 'Makefile' ∾ 966b077
  • maint (dev): update .editorconfig ∾ 4eb3d10
  • maint (polish): whitespace cleanup ∾ 3331b52

Refactoring

  • refactor ~ improve grouping/organization of package source code files ∾ db06c29

Pull Requests

  • Merge pull request #65 from barryib/case-sensitive-option
  • Merge pull request #59 from momotaro98/feature/add-emoji-template-in-init
  • Merge pull request #66 from barryib/add-upper-first-func
  • Merge pull request #68 from unixorn/tweak-readme

0.9.1 (2019-09-23)

[0.9.1; details]

No changelog for this release.

0.9.0 (2019-09-23)

feat: Add --tag-filter-pattern flag.

[0.9.0; details]

Features

  • feat: Add --tag-filter-pattern flag. ∾ 1198e28

Fixes

  • fix: Fixing tests on windows ∾ f5df8fa

Documentation

  • docs: Add windows installation ∾ af1f714

Pull Requests

  • Merge pull request #44 from evanchaoli/tag-filter
  • Merge pull request #41 from StanleyGoldman/fixing-tests-windows
  • Merge pull request #37 from ForkingSyndrome/master

0.8.0 (2019-02-23)

[0.8.0; details]

Features

  • feat: add the contains, hasPrefix, hasSuffix, replace, lower and upper functions to the template functions map ∾ dc12802

Pull Requests

  • Merge pull request #34 from atosatto/template-functions

0.7.1 (2018-11-10)

[0.7.1; details]

Fixes

  • fix: Panic occured when exec --next-tag with HEAD with tag ∾ e407b9a

Documentation

Pull Requests

  • Merge pull request #31 from drubin/patch-1
  • Merge pull request #30 from vvakame/fix-panic

0.7.0 (2018-05-06)

[0.7.0; details]

Features

  • feat: Add URL of output example for template style ∾ 87df4b4
  • feat: Add --next-tag flag (experimental) ∾ f8f4ccb

Fixes

  • fix: Remove accidentally added Unreleased.Tag ∾ 7a71844

Documentation

  • docs: Fix typo ∾ 4046d94
  • docs: Add document related on --next-tag ∾ 83ccab2

Maintenance

  • chore: Update changelog task in Makefile ∾ 5ad4cab

Test Improvements

  • test: Change output test of chglog to keep-a-changelog ∾ d008bef
  • test: Refactor for chglog test code ∾ 36cf6bc

Pull Requests

  • Merge pull request #22 from git-chglog/feat/add-preview-style-link
  • Merge pull request #21 from git-chglog/feat/next-tag

0.6.0 (2018-05-04)

[0.6.0; details]

Features

  • feat: Add tag name header id for keep-a-changelog template ∾ 481f6c0

Documentation

  • docs: docs: Update template example for README ∾ bcfe4d2

Maintenance

  • chore: Update CHANGELOG template format ∾ f97c6a0

Pull Requests

  • Merge pull request #20 from git-chglog/feat/kac-template-title-id

0.5.0 (2018-05-04)

[0.5.0; details]

Features

  • feat: Update template format to human readable ∾ 25c4182
  • feat: Add Unreleased field to RenderData ∾ 5ce1760

Fixes

  • fix: Add unreleased commits section to keep-a-changelog template #15 ∾ d3e1f56

Documentation

  • docs: Update template example for README ∾ 3f49f93
  • docs: Fix markdown table format ∾ f65b08d
  • docs: Fix "style" markdown format ∾ d44e8cc

Maintenance

  • chore: Update CHANGELOG template format ∾ 5564081

Pull Requests

  • Merge pull request #19 from git-chglog/fix/unreleased-commits
  • Merge pull request #18 from ringohub/master

0.4.0 (2018-04-14)

[0.4.0; details]

Features

  • feat: Add support for Bitbucket ∾ 21ae9e8

Documentation

  • docs: Update --init gif animation ∾ ab4e0f6
  • docs: Add Bitbucket section ∾ a00a2f2

Pull Requests

  • Merge pull request #17 from git-chglog/feat/bitbucket

0.3.3 (2018-04-07)

[0.3.3; details]

Features

  • feat: Change to kindly error message when git-tag does not exist ∾ 82d0df1

Documentation

  • docs: Update TODO List ∾ 588c3d0

Pull Requests

  • Merge pull request #16 from git-chglog/fix/empty-tag-handling

0.3.2 (2018-04-02)

[0.3.2; details]

Fixes

  • fix: Fix color output bug in windows help command ∾ e304986

Pull Requests

  • Merge pull request #14 from git-chglog/fix/windows-help-color

0.3.1 (2018-03-15)

[0.3.1; details]

Fixes

  • fix: fix preview string of commit subject ∾ b217d78

Pull Requests

  • Merge pull request #13 from kt3k/feature/fix-preview

0.3.0 (2018-03-12)

[0.3.0; details]

Features

  • feat: Add support for GitLab ∾ 45ed6e3

Documentation

  • docs: Add document related to GitLab ∾ 0a623f3
  • docs: Fix old template section in document ∾ d446571

Maintenance

  • chore: Add helper task for generate CHANGELOG ∾ 081aa8d

Pull Requests

  • Merge pull request #12 from git-chglog/feat/gitlab

0.2.0 (2018-03-02)

[0.2.0; details]

Features

  • feat: Add template for Keep a changelog to the --init option ∾ ed6fb27
  • feat: Supports vim like j/k keybind with item selection of --init ∾ 790a2e6

Documentation

  • docs: Change CHANGELOG format to Keep a changelog ∾ 7a004f8
  • docs: Add AppVeyor status badge ∾ dd838e8

Maintenance

  • chore: Fix release flow (retry) ∾ 4059813
  • chore: Add AppVeyor config ∾ f9ab379

Test Improvements

  • test: Pass all the test cases with windows ∾ 98543fb

Pull Requests

  • Merge pull request #11 from git-chglog/develop
  • Merge pull request #10 from mattn/fix-test
  • Merge pull request #9 from mattn/windows-color

0.1.0 (2018-02-25)

[0.1.0; details]

Features

  • feat: Supports annotated git-tag and adds Tag.Subject field #3 ∾ 114b7d6
  • feat: Remove commit message preview on select format ∾ 7a6d2a0
  • feat: Add Git Basic to commit message format ∾ 25bb6e1
  • feat: Add preview to the commit message format of --init option ∾ a7d8646

Fixes

  • fix: Fix a bug that Commit.Revert.Header is not converted by GitHubProcessor ∾ d165ea8
  • fix: Fix error message when Tag can not be acquired ∾ b01be88
  • fix a small typo, no content changes ∾ 6566949
  • fix: Fix Revert of template created by Initializer ∾ aa5cf09

Documentation

  • docs: Update --init gif animation ∾ 8fb0c7f
  • docs: Add coveralls status badge ∾ 7fe88a3
  • docs: Add contributing guide and Issues/PR templates ∾ ccd7250
  • docs: Update --init option demo gif animation ∾ 4910289

Maintenance

  • chore: Fix release scripts ∾ f8160a2
  • chore: Remove unnecessary task ∾ 1b2210d
  • chore: Add coverage measurement task for local confirmation ∾ b738561
  • chore: Change release method of git tag on TravisCI ∾ c7ca5ce

Refactoring

  • refactor: Refactor Initializer to testable ∾ 8780cd1

Test Improvements

  • test: Add coverage measurement using coveralls ∾ 2b81993
  • test: Fix test which failed due to timezone difference ∾ 96562bc

Pull Requests

  • Merge pull request #8 from git-chglog/feat/0.0.3
  • Merge pull request #6 from git-chglog/chore/coverage
  • Merge pull request #4 from paralax/patch-1
  • Merge pull request #5 from git-chglog/develop
  • Merge pull request #1 from git-chglog/develop

0.0.2 (2018-02-18)

[0.0.2; details]

Documentation

Maintenance

  • chore: Fix release script ∾ fc2b625
  • chore: Add release process ∾ 8292ab7

0.0.1 (2018-02-18)

[0.0.1; details]

Features

  • feat: Add cli client ∾ 066fa21
  • feat: Add commits in commit version struct ∾ 153727e
  • feat: Add config normalize process ∾ 633c7f0
  • feat: Add Next and Previous in Tag ∾ d4d2a7e
  • feat: Add MergeCommits and RevertCommits ∾ fd369d4
  • feat: First implement ∾ 6caf676

Fixes

  • fix: Fix parsing of revert and body ∾ 8869631

Documentation

Maintenance

  • chore: Fix timezone in TravisCI ∾ ec1d4de
  • chore: Add travis configuration ∾ 1d37984
  • chore: Add Makefile for task management ∾ 4dd9b35
  • chore: Fix testcase depending on datetime ∾ cd96846
  • chore: Update vendor packages ∾ 2179ede
  • chore: Add e2e tests ∾ 8b6430e
  • chore: Setup gitignore ∾ 8c7c870
  • chore: Initial commit ∾ a44743e
  • maint (editor): add Editorconfig ∾ 78c2f1e

Refactoring

  • refactor: Fix typo ∾ 5599878
  • refactor: Change to return an error if corresponding commit is empty ∾ 22cfb51
  • refactor: Refactor the main logic ∾ 8f31716