Releases: phly/keep-a-changelog
keep-a-changelog 1.6.0
Added
-
#46 adds the
--provider-domain
option to each of theentry:*
andrelease
commands, and the correspondingdomain
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 tobump
/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 toversion:edit
. -
#41 adds an optional
<version>
argument to theversion:edit
command,
allowing users to edit a specific release version entry.
Deprecated
- #41 deprecates the
edit
command in favor ofversion: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}]
.
keep-a-changelog 1.5.1
Added
- Nothing.
Changed
- Nothing.
Deprecated
- Nothing.
Removed
- Nothing.
Fixed
keep-a-changelog 1.5.0
Added
-
#24 adds a GitLab repository provider. You can specify the new provider via a
new--provider gitlab
option to either thetag
orrelease
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
andentry:*
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.
keep-a-changelog 1.4.4
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 aHEAD
request on the generated link to determine if it is
valid, following redirects as encountered.
Deprecated
- Nothing.
Removed
- Nothing.
Fixed
- Nothing.
keep-a-changelog 1.4.3
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.
keep-a-changelog 1.4.2
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.
keep-a-changelog 1.4.1
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.
keep-a-changelog 1.4.0
Added
- #16 adds functionality to prevent an existing changelog
from being overwritten by thenew
command, and adds an--overwrite
option
to allow overwriting the file.
Changed
- Nothing.
Deprecated
- Nothing.
Removed
- Nothing.
Fixed
- Nothing.
keep-a-changelog 1.3.0
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.
keep-a-changelog 1.2.1
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.