You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+15-6Lines changed: 15 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,6 @@
1
1
# changelog-updater
2
2
3
-
A PHP CLI to update a CHANGELOG following the "Keep a Changelog" format with the latest release notes.
4
-
5
-
> ⚠️ This package/CLI is still in active development. Breaking changes might occur until v1 is tagged.
3
+
A PHP CLI to update a CHANGELOG following the ["Keep a Changelog"](https://keepachangelog.com/) format with the latest release notes.
6
4
7
5
[](https://packagist.org/packages/wnx/changelog-updater)
Want to automate the process of updating your Changelog withs GitHub Actions? Checkout the [stefanzweifel/changelog-updater-action](https://github.com/stefanzweifel/changelog-updater-action) which does exactly that.
13
+
14
14
## Installation
15
15
16
16
You can install the changelog-updater CLI as a global composer dependency:
Note that the CHANGELOG MUST to follow the "[Keep a Changelog](https://keepachangelog.com/en/1.0.0/)"-format. In detail, the CLI looks for a second level "Unreleased"-heading with a link. The link MUST to point to the compare view of the latest version and `HEAD`.
43
+
`--release-date`, `--path-to-changelog` and `--write` are optional. Learn more about the options by running `php changelog-updater update --help`.
44
+
45
+
46
+
### Important
47
+
48
+
Note that the Changelog MUST follow the "[Keep a Changelog](https://keepachangelog.com/en/1.0.0/)"-format.
49
+
The CLI looks for a second level "Unreleased"-heading with a link. The link MUST point to the compare view of the latest version and `HEAD`.
44
50
The CLI also looks for a second level heading with the name of the previous version. (If you release `v1.1.0` now, the previous version might be `v1.0.0`.)
45
-
Here is an example Markdown file.
51
+
52
+
Here is an example Markdown file, that will work fine with the CLI.
46
53
47
54
48
55
```md
@@ -62,6 +69,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
62
69
- Initial Release
63
70
```
64
71
72
+
The content between the "Unreleased"-heading the the latest version will remain untouched by the CLI.
0 commit comments