Skip to content

Latest commit

 

History

History
1075 lines (588 loc) · 24.5 KB

CHANGELOG.md

File metadata and controls

1075 lines (588 loc) · 24.5 KB
Raw

Changelog

All notable changes to this project will be documented in this file, in reverse chronological order by release.

2.12.2 - TBD

Added

  • Nothing.

Changed

  • Nothing.

Deprecated

  • Nothing.

Removed

  • Nothing.

Fixed

  • Nothing.

2.12.1 - 2022-09-02

Added

  • Nothing.

Changed

  • Nothing.

Deprecated

  • Nothing.

Removed

  • Nothing.

Fixed

  • Fixes an issue with the version:release command whereby GitHub/GitLab tokens were not correctly consumed, leading to exceptions.

2.12.0 - 2022-09-02

Added

  • Adds support for symfony/console v6 releases (thanks to @ramsey).

Changed

  • The utility now uses the composer-runtime-api for purposes of reporting its version.

Deprecated

  • Nothing.

Removed

  • This release removes support for Composer version 1 releases.

Fixed

  • Nothing.

2.11.0 - 2021-01-20

Added

  • #97 adds support for PHP 8.0.

Changed

  • #97 updates to use the v3 release of knplabs/github-api.

Deprecated

  • Nothing.

Removed

  • #97 removes support for PHP versions < 7.4.

Fixed

  • Nothing.

2.10.1 - 2020-10-09

Added

  • Nothing.

Changed

  • Nothing.

Deprecated

  • Nothing.

Removed

  • Nothing.

Fixed

  • #94 fixes parsing of the Location header when determining redirects for the GitLab provider. GitLab will sometimes provide multiple values for the header, versus the expected single value. The provider now pulls the first one from a list if multiple are present.

2.10.0 - 2020-09-15

Added

  • Nothing.

Changed

  • #92 modifies the version:tag and version:release commands. In each, the version argument is now optional; when not provided, the tooling will discover the first releasable version in the changelog (essentially, the first with a release date associated), and prompt the user to confirm using that version.

Deprecated

  • Nothing.

Removed

  • Nothing.

Fixed

  • Nothing.

2.9.1 - 2020-09-15

Added

  • Nothing.

Changed

  • Nothing.

Deprecated

  • Nothing.

Removed

  • Nothing.

Fixed

  • #91 differentiates the various reasons why version:tag fails, and adds more help information both when requested and when running the command.

  • #90 modifies the various events that communicate with the configured Git provider to indicate when invalid credentials were used, versus providing a generic failure message.

  • #89 fixes the config:create command to emit an error message and return a non-zero status when neither the --local|-l nor the --global|-g options have been provided.

  • #88 fixes an issue where using the phly/keep-a-changelog PHAR with configuration would lead to errors about the inability to locate provider classes. These are now resolved correctly by the PHAR.

  • #88 fixes an issue whereby calling config:create -l with a phly/keep-a-changelog PHAR file would result in unusable local configuration due to a string injected in the config template during PHAR creation.

2.9.0 - 2020-09-01

Added

  • #80 adds support for more verbose changelog headings. The heading no longer must be exactly # Changelog. Rather, it can be # My Project's Changelog or # The changelog for all the things. The word "changelog" must still be somewhere in the heading.

Changed

  • Nothing.

Deprecated

  • Nothing.

Removed

  • Nothing.

Fixed

  • Nothing.

2.8.1 - 2020-09-01

Added

  • Nothing.

Changed

  • Nothing.

Deprecated

  • Nothing.

Removed

  • Nothing.

Fixed

  • #79 fixes a case where the bump command (and its subcommands) would result in a fatal error if unable to detect any changelog entries.

2.8.0 - 2020-08-03

Added

  • #78 adds accessor methods with return types to the Phly\KeepAChangelog\Common\ChangelogEntry class. This change only affects code consumers of the package, and has no effect on end-user consumers of the tooling.

Changed

  • Nothing.

Deprecated

  • Nothing.

Removed

  • Nothing.

Fixed

  • Nothing.

2.7.0 - 2020-07-30

Added

  • Nothing.

Changed

  • #77 updates the php-http/guzzle6-adapter dependency to also allow 2.0 versions, allowing the tool to coexist with other tools depending on that later version. Functionally, there are no changes.

Deprecated

  • Nothing.

Removed

  • Nothing.

Fixed

  • Nothing.

2.6.0 - 2020-07-28

Added

  • #76 adds "milestone" commands for listing, creating, and closing milestones:

    • milestone:list will list milestones.
    • milestone:create will create a milestone, optionally with a description.
    • milestone:close will close a milestone.

  • #76 adds --create-milestone and --create-milestone-with-name options to the bump:* and unreleased:promote commands, allowing them to optionally create a milestone on completion.

  • #76 adds a new provider interface, MilestoneAwareProviderInterface, for indicating that a provider is capable of manipulating project milestones.

Changed

  • Nothing.

Deprecated

  • Nothing.

Removed

  • Nothing.

Fixed

  • Nothing.

Unreleased - TBD

Added

  • Nothing.

Changed

  • Nothing.

Deprecated

  • Nothing.

Removed

  • Nothing.

Fixed

  • Nothing.

2.5.0 - 2020-07-16

Added

  • #75 adds the ability to correctly parse, show, and manipulate a changelog marked Unreleased in your changelog file, per the 1.0.0 version of the Keep-A-Changelog spec.

  • #75 adds the command unreleased:create, allowing you to create an Unreleased release in your changelog.

  • #75 adds the command unreleased:promote <version> [--date|-d], allowing you to rename an Unreleased release to the given version, and set the release date (defaulting to the current date).

Changed

  • #73 adds a new listener to the version:tag command, VerifyVersionHasReleaseDateListener. This listener ensures that you cannot tag a release that has not had its release date set in the changelog yet, aborting if the date is not present.

  • #74 changes the behavior of version:tag slightly, by adding a check to see if we have a clean checkout currently. If not, it will abort the operation. Users can pass a new --force option to force the operation to continue.

Deprecated

  • Nothing.

Removed

  • Nothing.

Fixed

  • Nothing.

2.4.0 - 2020-05-01

Added

  • Nothing.

Changed

  • #72 expands the regexp used to validate a version string to allow including a hyphen (-) between the version and stability, as well as a period (.) between the stability and revision identifier. As an example, the version "1.2.3-rc.1" will now be considered valid by the keep-a-changelog tool.

  • #71 changes the values of the constants BumpCommand::BUMP_BUGFIX and ::BUMP_PATCH to be "patch" instead of "bugfix", making them better align with the verbiage in version 2.0 of the Keep A Changelog specification. Usage of the tool does not change, however.

Deprecated

  • Nothing.

Removed

  • Nothing.

Fixed

  • Nothing.

2.3.0 - 2020-01-30

Added

  • #67 adds self-contained PHAR files to new releases.

Changed

  • Nothing.

Deprecated

  • Nothing.

Removed

  • Nothing.

Fixed

  • Nothing.

2.2.0 - 2019-12-03

Added

  • Adds PHP 7.4 support.

Changed

  • #63 adds support for symfony/console v5 releases.

Deprecated

  • Nothing.

Removed

  • Nothing.

Fixed

  • Nothing.

2.1.2 - 2019-11-07

Added

  • Nothing.

Changed

  • Nothing.

Deprecated

  • Nothing.

Removed

  • Nothing.

Fixed

  • #62 fixes how the command handles the return value when prompting for a remote to use. Previously, it was using the index, instead of looking up the remote name by the index, which would lead to errors.

2.1.1 - 2019-10-16

Added

  • Nothing.

Changed

  • Nothing.

Deprecated

  • Nothing.

Removed

  • Nothing.

Fixed

  • #61 fixes an issue that presented when the tag name associated with a release differs from the version.

2.1.0 - 2019-06-06

Added

  • #56 adds a new command, changelog:edit-links, to allow editing reference links in the changelog file.

  • #57 [DEVELOPERS] This patch adds two traits for listeners that use the Editor or ChangelogEditor; these traits facilitate testing.

Changed

  • Nothing.

Deprecated

  • Nothing.

Removed

  • Nothing.

Fixed

  • #56 / #38 fixes parsing of the changelog file to ensure it recognizes versions using the reference link format.

2.0.0 - 2019-06-04

Added

  • Configuration is now a first-class citizen within the tooling, and is merged (in order of ascending priority) from each of package defaults, $XDG_CONFIG_HOME/keep-a-changelog.ini (usually $HOME/.config/keep-a-changelog.ini), $PWD/.keep-a-changelog.ini (the directory in which you run the command), and command options. Configuration has the following format:

    [defaults]
changelog_file = CHANGELOG.md
provider = github
remote = origin
package = some/package ; local ($PWD) config only

[providers]
github[class] = Phly\KeepAChangelog\Provider\GitHub
github[token] = authorization-token ; global config only
github[url] = https://some-custom-install.github.com
gitlab[class] = Phly\KeepAChangelog\Provider\GitLab
gitlab[token] = authorization-token ; global config only
gitlab[url] = https://some-custom-install.gitlab.com

    Full details can be found in the README.md file.

  • Adds the command config:edit, which allows editing a global or local configuration file within your specified editor (either $EDITOR or the value of the --editor option).

  • Adds the command config:remove, which allows removing either a global or local configuration file.

  • Adds the command config:show, which allows showing the contents of either a global or local configuration file, or the merged values of the two.

  • The version:edit command now allows you to specify the specific changelog version you wish to edit. If you do not specify a version, it assumes the most recent listed.

  • The various entry:* commands now allow you to specify the specific changelog version (via --version) to which to add the new entry, instead of only allowing adding to the most recent.

Changed

  • The tooling now requires PHP 7.2, as it consumes and implements PSR-14 (Event Dispatcher) internally.

  • Configuration has changed, including where it is stored. If you were using configuration previously, generate new configuration using keep-a-changelog config:create --global, and then copy relevant details from your $HOME/.keep-a-changelog/config.ini to the new configuration file (you can use keep-a-changelog config:edit --global to edit the new file).

  • When calling version:release or the various entry:* commands, package names can now be autodiscovered via one of:

    • The local configuration file.
    • A Composer composer.json file (via the name key).
    • An NPM package.json file (via the name key).

    This means you likely no longer need to specify the package name when pushing a release via the tooling.

  • When calling version:tag, git remote names can now be specified via one of:

    • The global configuration file.
    • The local configuration file.
    • Command-line option.
    • Autodiscovery via .git/config, using the configured provider and package name.

  • The --file|-f global option for specifying a changelog file is now --changelog|-c.

  • The version:release command now makes the <package> argument a --package option.

  • The version:release command now allows releasing any version; this can be useful when creating historical releases.

  • The internals were completely rewritten. If you were extending or consuming any classes previously, they are likely either removed, renamed, or rewritten at this time. In particular, all commands are now under sub-namespaces, and dispatch events instead of performing logic internally. This approach should make understanding the workflow of individual commands simpler.

Deprecated

  • Nothing.

Removed

  • Removes the config command; use config:create instead.

  • Removes the edit command; use version:edit instead.

  • Removes the new command; use changelog:new instead.

  • Removes the ready command; use version:ready instead.

  • Removes the release command; use version:release instead.

  • Removes the tag command; use version:tag instead.

Fixed

  • Nothing.

1.6.1 - 2019-05-14

Added

  • Nothing.

Changed

  • #48 adds the string : to then end of all question prompts to make them more readable.

Deprecated

  • Nothing.

Removed

  • Nothing.

Fixed

  • #52 removes the Throwable $e argument to MissingTagException::forUnverifiedTagOnGithub() as no Throwable was available in the context in which it was called.

  • #47 fixes a bug during global configuration file creation that occurs when the configuration directory does not exist.

1.6.0 - 2019-05-07

Added

  • #46 adds the --provider-domain option to each of the entry:* and release commands, and the corresponding domain key in .keep-a-changelog.ini files. The option can be used to specify a custom domain for your chosen provider; it will be used to determine which git remote to push tags to, to generate links for changelog entries, and to make API calls to the provider.

  • #44 adds the command bump:patch as an alias to bump/bump:bugfix.

  • #33 adds support for usage with the symfony/console 3.4 series.

  • #41 adds the command version:list, which will list all versions and associated release dates from the changelog file.

  • #41 adds the command version:remove <version>, which will remove the changelog entry for the provided version, if it exists.

  • #41 adds the command version:show <version>, which will show the full release entry in the changelog for the provided version, along with its release date.

Changed

  • #41 aliases the edit command to version:edit.

  • #41 adds an optional <version> argument to the version:edit command, allowing users to edit a specific release version entry.

Deprecated

  • #41 deprecates the edit command in favor of version:edit.

Removed

  • Nothing.

Fixed

  • #45 updates the GitHub provider such that it now verifies that a signed commit matching the release has been pushed before attempting to create a release.

  • #45 updates the release command to no longer hard-code using "origin" as the remote, and to instead lookup the remote based on the provider and package. When multiple remotes match (which should not happen), it will prompt the user to choose one, or abort.

  • #43 fixes the markup used to generate a link to a merge request when using GitLab as your provider. In that scenario, the markup [!{merge number}] will now be used instead of [#{merge number}].

1.5.1 - 2018-11-08

Added

  • Nothing.

Changed

  • Nothing.

Deprecated

  • Nothing.

Removed

  • Nothing.

Fixed

  • #32 fixes the order of arguments to the getToken() method invoked within ReleaseCommand, resolving a syntax error.

  • #31 fixes a syntax error in the release command.

  • #30 fixes the EntryCommand, adding a missing global (-g) option.

1.5.0 - 2018-11-07

Added

  • #24 adds a GitLab repository provider. You can specify the new provider via a new --provider gitlab option to either the tag or release commands.

  • #27 adds the ability to create either a local or global config file containing both the preferred/default provider to use, and its associated token. Usage is keep-a-changelog config, optionally with a --global or -g flag. The command will then prompt you for the provider and token.

Changed

  • #27 modifies each of the release and entry:* commands to use the appropriate global or local configuration file, if found, to determine the provider and/or token to use; if either of the --token or --provider options are provided during invocation, those will override the values from configuration.

Deprecated

  • Nothing.

Removed

  • Nothing.

Fixed

  • Nothing.

1.4.4 - 2018-04-26

Added

  • Nothing.

Changed

  • #22 modifies how PR links are generated in several ways:
    • If the provided package name does not result in a valid PR link, it raises an excepion.
    • If the package name discovered in the composer.json does not result in a valid PR link, it then
    • Probes the git remotes to find the first that results in a valid package link. In each case, it performs a HEAD request on the generated link to determine if it is valid, following redirects as encountered.

Deprecated

  • Nothing.

Removed

  • Nothing.

Fixed

  • Nothing.

1.4.3 - 2018-04-25

Added

  • Nothing.

Changed

  • Nothing.

Deprecated

  • Nothing.

Removed

  • Nothing.

Fixed

  • #21 fixes an issue with releasing that occurs when the token file contains any additional whitespace (such as a trailing EOL character), resolving problems with creating a release via the GitHub API.

1.4.2 - 2018-04-25

Added

  • Nothing.

Changed

  • Nothing.

Deprecated

  • Nothing.

Removed

  • Nothing.

Fixed

  • Fixes the exception message emitted when new is called and a changelog file already exists to properly mention the --overwrite, not the --override, option.

  • #20 fixes detection of a changelog when only one changelog entry is present in the file.

1.4.1 - 2018-04-25

Added

  • Nothing.

Changed

  • Nothing.

Deprecated

  • Nothing.

Removed

  • Nothing.

Fixed

  • #19 fixes the new command to correctly detect the --overwrite option instead of the --override option.

1.4.0 - 2018-04-20

Added

  • #16 adds functionality to prevent an existing changelog from being overwritten by the new command, and adds an --overwrite option to allow overwriting the file.

Changed

  • Nothing.

Deprecated

  • Nothing.

Removed

  • Nothing.

Fixed

  • Nothing.

1.3.0 - 2018-04-16

Added

  • #14 adds a new global option, --file (or -f), to allow specifying an alternate changelog file to create or modify.

  • #12 adds a new command, "bump:to-version". This command will add a new changelog entry for the version specified on the command line at the top of the changelog file.

  • #11 Adds a new command, "new", for creating a new changelog file. The file will be created in CHANGELOG.md in the current directory unless a --file option is provided. The initial version will be 0.1.0 unless an --initial-version option is provided.

Changed

  • Nothing.

Deprecated

  • Nothing.

Removed

  • Nothing.

Fixed

  • Nothing.

1.2.1 - 2018-04-15

Added

  • Nothing.

Changed

  • Nothing.

Deprecated

  • Nothing.

Removed

  • Nothing.

Fixed

  • Fixes a problem with the edit command successful message template, switching from <success> (which does not exist) to <info>.

  • #10 adds a dependency on ocramius/package-versions in order to ensure that the script version is auto-updated for each tag.

1.2.0 - 2018-04-14

Added

  • Adds a new command, "edit", which will open the most recent changelog entry in an editor. By default, it uses $EDITOR, unless an alternate editor is provided via the --editor option. It will edit the file CHANGELOG.md unless an alternate file is provided via the --file option.

  • Adds a new command, "ready", which will set the date for the first un-dated changelog entry in the CHANGELOG.md. You may also pass the --date or -d option to specify an alternate date, or to use a date formate other than YYYY-MM-DD.

Changed

  • Nothing.

Deprecated

  • Nothing.

Removed

  • Nothing.

Fixed

  • Nothing.

1.1.2 - 2018-04-12

Added

  • Nothing.

Changed

  • Nothing.

Deprecated

  • Nothing.

Removed

  • Nothing.

Fixed

  • Sets the release version for the tool, bumping it to 1.1.2 from 1.0.3dev1.

1.1.1 - 2018-04-12

Added

  • Nothing.

Changed

  • Nothing.

Deprecated

  • Nothing.

Removed

  • Nothing.

Fixed

  • Fixes the dev-master branch alias in the package definition to ensure the package validates.

1.1.0 - 2018-04-12

Added

  • Adds the command "entry:fixed", for adding an entry to the Fixed section of the current changelog.

  • Adds the command "entry:removed", for adding an entry to the Removed section of the current changelog.

  • Adds the command "entry:deprecated", for adding an entry to the Deprecated section of the current changelog.

  • Adds the command "entry:changed", for adding an entry to the Changed section of the current changelog.

  • Adds the command "entry:added", for adding an entry to the Added section of the current changelog.

Changed

  • Nothing.

Deprecated

  • Nothing.

Removed

  • Nothing.

Fixed

  • Nothing.

1.0.2 - 2018-03-27

Added

  • Nothing.

Changed

  • Nothing.

Deprecated

  • Nothing.

Removed

  • Nothing.

Fixed

  • Fixes an autoloading issue when running globally.

1.0.1 - 2018-03-27

Added

  • Nothing.

Changed

  • Nothing.

Deprecated

  • Nothing.

Removed

  • Removes dependency on ocramius/package-versions.

Fixed

  • Fixes error that occurs when running globally, due to a dependency that only works when running in a local package.

1.0.0 - 2018-03-27

Initial release.

Added

  • Nothing.

Changed

  • Nothing.

Deprecated

  • Nothing.

Removed

  • Nothing.

Fixed

  • Nothing.