Skip to content

Commit 5c98bb7

Browse files
committed
Merging develop to master in preparation for 1.6.0 release.
2 parents 8585813 + e53ff5b commit 5c98bb7

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+1880
-226
lines changed

.travis.yml

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,6 @@ matrix:
1919
- php: 7.1
2020
env:
2121
- DEPS=locked
22-
- CS_CHECK=true
23-
- TEST_COVERAGE=true
2422
- php: 7.1
2523
env:
2624
- DEPS=latest
@@ -30,9 +28,20 @@ matrix:
3028
- php: 7.2
3129
env:
3230
- DEPS=locked
31+
- CS_CHECK=true
32+
- TEST_COVERAGE=true
3333
- php: 7.2
3434
env:
3535
- DEPS=latest
36+
- php: 7.3
37+
env:
38+
- DEPS=lowest
39+
- php: 7.3
40+
env:
41+
- DEPS=locked
42+
- php: 7.3
43+
env:
44+
- DEPS=latest
3645

3746
before_install:
3847
- if [[ $TEST_COVERAGE != 'true' ]]; then phpenv config-rm xdebug.ini || return 0 ; fi

CHANGELOG.md

Lines changed: 37 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -2,27 +2,59 @@
22

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

5-
## 1.5.2 - TBD
5+
## 1.6.0 - 2019-05-07
66

77
### Added
88

9-
- Nothing.
9+
- [#46](https://github.com/phly/keep-a-changelog/pull/46) adds the `--provider-domain` option to each of the `entry:*` and `release`
10+
commands, and the corresponding `domain` key in `.keep-a-changelog.ini` files.
11+
The option can be used to specify a custom domain for your chosen provider; it
12+
will be used to determine which git remote to push tags to, to generate links
13+
for changelog entries, and to make API calls to the provider.
14+
15+
- [#44](https://github.com/phly/keep-a-changelog/pull/44) adds the command `bump:patch` as an alias to `bump`/`bump:bugfix`.
16+
17+
- [#33](https://github.com/phly/keep-a-changelog/pull/33) adds support for usage with the symfony/console 3.4 series.
18+
19+
- [#41](https://github.com/phly/keep-a-changelog/pull/41) adds the command `version:list`, which will list all versions and
20+
associated release dates from the changelog file.
21+
22+
- [#41](https://github.com/phly/keep-a-changelog/pull/41) adds the command `version:remove <version>`, which will remove the
23+
changelog entry for the provided version, if it exists.
24+
25+
- [#41](https://github.com/phly/keep-a-changelog/pull/41) adds the command `version:show <version>`, which will show the full
26+
release entry in the changelog for the provided version, along with its
27+
release date.
1028

1129
### Changed
1230

13-
- Nothing.
31+
- [#41](https://github.com/phly/keep-a-changelog/pull/41) aliases the `edit` command to `version:edit`.
32+
33+
- [#41](https://github.com/phly/keep-a-changelog/pull/41) adds an optional `<version>` argument to the `version:edit` command,
34+
allowing users to edit a specific release version entry.
1435

1536
### Deprecated
1637

17-
- Nothing.
38+
- [#41](https://github.com/phly/keep-a-changelog/pull/41) deprecates the `edit` command in favor of `version:edit`.
1839

1940
### Removed
2041

2142
- Nothing.
2243

2344
### Fixed
2445

25-
- Nothing.
46+
- [#45](https://github.com/phly/keep-a-changelog/pull/45) updates the `GitHub` provider such that it now verifies that a signed
47+
commit matching the release has been pushed before attempting to create a
48+
release.
49+
50+
- [#45](https://github.com/phly/keep-a-changelog/pull/45) updates the `release` command to no longer hard-code using "origin" as the
51+
remote, and to instead lookup the remote based on the provider and package.
52+
When multiple remotes match (which should not happen), it will prompt the user
53+
to choose one, or abort.
54+
55+
- [#43](https://github.com/phly/keep-a-changelog/pull/43) fixes the markup used to generate a link to a merge request when using
56+
GitLab as your provider. In that scenario, the markup `[!{merge number}]` will
57+
now be used instead of `[#{merge number}]`.
2658

2759
## 1.5.1 - 2018-11-08
2860

@@ -292,28 +324,6 @@ All notable changes to this project will be documented in this file, in reverse
292324

293325
- Nothing.
294326

295-
## 1.1.3 - TBD
296-
297-
### Added
298-
299-
- Nothing.
300-
301-
### Changed
302-
303-
- Nothing.
304-
305-
### Deprecated
306-
307-
- Nothing.
308-
309-
### Removed
310-
311-
- Nothing.
312-
313-
### Fixed
314-
315-
- Nothing.
316-
317327
## 1.1.2 - 2018-04-12
318328

319329
### Added

README.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,10 @@ The available providers are:
5353

5454
Currently supported commands include:
5555

56+
- `new` will create a new changelog file for you; specify `--initial-version` or
57+
`-i` if you want to start with a version other than 0.1.0; use `--file` or
58+
`-f` to specify a file other than `CHANGELOG.md`.
59+
5660
- `config` will create a config file after prompting you for the preferred
5761
provider and its associated token. By default, the file is stored locally as
5862
`.keep-a-changelog.ini`; if the `--global` (or `-g`) option is provided, the
@@ -94,8 +98,16 @@ Currently supported commands include:
9498
- `entry:fixed` will add a new changelog entry to the Fixed section of the
9599
current changelog within the `CHANGELOG.md` file.
96100

97-
- `edit` will open the most recent changelog section in the system editor
98-
to allow editing the full entry at once.
101+
- `version:edit` will open the most recent changelog section in the system editor
102+
to allow editing the full entry at once. If you provide a `<version>`
103+
argument, it will edit that specific version.
104+
105+
- `version:list` will list all versions in the changelog, along with associated
106+
release dates.
107+
108+
- `version:remove` will remove the given version's entry from the changelog.
109+
110+
- `version:show` will show the entry associated with the given version.
99111

100112
For a list of required parameters and all options for a command, run:
101113

bin/keep-a-changelog

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<?php
33
/**
44
* @see https://github.com/phly/keep-a-changelog for the canonical source repository
5-
* @copyright Copyright (c) 2018 Matthew Weier O'Phinney
5+
* @copyright Copyright (c) 2018-2019 Matthew Weier O'Phinney
66
* @license https://github.com/phly/keep-a-changelog/blob/master/LICENSE.md New BSD License
77
*/
88

@@ -38,19 +38,24 @@ $application->getDefinition()
3838
$application->addCommands([
3939
new BumpCommand(BumpCommand::BUMP_BUGFIX, 'bump'),
4040
new BumpCommand(BumpCommand::BUMP_BUGFIX, 'bump:bugfix'),
41+
new BumpCommand(BumpCommand::BUMP_BUGFIX, 'bump:patch'),
4142
new BumpCommand(BumpCommand::BUMP_MINOR, 'bump:minor'),
4243
new BumpCommand(BumpCommand::BUMP_MAJOR, 'bump:major'),
4344
new BumpToVersionCommand('bump:to-version'),
4445
new ConfigCommand('config'),
45-
new EditCommand('edit'),
46+
new EditCommand('edit', $deprecated = true),
47+
new EditCommand('version:edit'),
4648
new EntryCommand('entry:added'),
4749
new EntryCommand('entry:changed'),
4850
new EntryCommand('entry:deprecated'),
4951
new EntryCommand('entry:removed'),
5052
new EntryCommand('entry:fixed'),
53+
new ListVersionsCommand('version:list'),
5154
new NewChangelogCommand('new'),
5255
new ReadyCommand('ready'),
5356
new ReleaseCommand('release'),
57+
new RemoveCommand('version:remove'),
58+
new ShowVersionCommand('version:show'),
5459
new TaggerCommand('tag'),
5560
]);
5661
$application->run();

composer.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
"m4tthumphrey/php-gitlab-api": "^9.9",
1717
"ocramius/package-versions": "^1.3",
1818
"php-http/guzzle6-adapter": "^1.1",
19-
"symfony/console": "^4.0"
19+
"symfony/console": "^3.4|^4.0"
2020
},
2121
"require-dev": {
2222
"mikey179/vfsStream": "^1.6",
@@ -38,8 +38,8 @@
3838
},
3939
"extra": {
4040
"branch-alias": {
41-
"dev-master": "1.5.x-dev",
42-
"dev-develop": "1.6.x-dev"
41+
"dev-master": "1.6.x-dev",
42+
"dev-develop": "1.7.x-dev"
4343
}
4444
},
4545
"bin": [

composer.lock

Lines changed: 18 additions & 18 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

src/BumpCommand.php

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ class BumpCommand extends Command
2626
public const BUMP_BUGFIX = 'bugfix';
2727
public const BUMP_MAJOR = 'major';
2828
public const BUMP_MINOR = 'minor';
29+
public const BUMP_PATCH = self::BUMP_BUGFIX;
2930

3031
private const DESC_TEMPLATE = 'Create a new changelog entry for the next %s release.';
3132

0 commit comments

Comments
 (0)