Download the PHP package shopsys/changelog-linker without Composer
On this page you can find all versions of the php package shopsys/changelog-linker. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download shopsys/changelog-linker
More information about shopsys/changelog-linker
Files in shopsys/changelog-linker
Package changelog-linker
Short Description [FORK] Generates beautiful CHANGELOG.md with links to PRs, versions and users grouped in Added/Changed/Fixed/Removed categories.
License
Informations about the package changelog-linker
Changelog Linker
Turn your CHANGELOG.md
from a machine readable text to a rich text that makes every programmer happy.
Install
Usage
Create changelog-linker.yml
with configuration:
The config is autodiscovered in the root directory or by --config
option.
A. Dump Merges
Write or Dry-run?
The --dry-run
option prints the result to the output. Without that, I looks for <!-- changelog-linker -->
in the CHANGELOG.md
to replace with the content.
It finds the last #ID in the CHANGELOG.md
, than looks on Github via API and dumps all the merged PRs since the last #ID in nice format. In case you want to specify minimal PR id yourself, use this:
But that is a mash-up of everything. Not very nice:
What if we'd have Added, Changed... all the standard categories?
↓
Nice, now everything is nicely grouped.
(Do you want to know how we detect the category? Follow me)
What about packages - can we have group them as well? Sure:
↓
(Technical secret: it reacts to [Package] in PR title.)
Let's take it one step further!
↓
Do you prefer categories first? Just switch the order:
↓
Github API Overload?
In case you cross the API rate limit and get denied, create new Github Token and run it via GITHUB_TOKEN
ENV variable.
B. Decorate CHANGELOG.md
1. Link PR and Issues
2. Link Versions to Diffs
3. Can I Thank My Contributors?
Of course! Give your contributors credit they deserve:
You can exclude core maintainers, to give external contributors more credit:
4. How to Link Specific Words?
In Symplify, I need that every EasyCodingStandard
word leads to https://github.com/Symplify/EasyCodingStandard/
.
5. Can I Write Shorter PR Titles?
Just add alias to config:
...and it will be resolved to CodingStandard
package.
All versions of changelog-linker with dependencies
guzzlehttp/guzzle Version ^6.3
nette/utils Version ^2.5
symfony/console Version ^3.4|^4.1
symfony/http-kernel Version ^3.4|^4.1
symfony/process Version ^3.4|^4.1
symplify/package-builder Version ^5.4.6