Download the PHP package symplify/changelog-linker without Composer
On this page you can find all versions of the php package symplify/changelog-linker. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download symplify/changelog-linker
More information about symplify/changelog-linker
Files in symplify/changelog-linker
Package changelog-linker
Short Description Generates beautiful CHANGELOG.md with links to PRs, versions and users grouped in Added/Changed/Fixed/Removed categories.
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package changelog-linker
[DEPREACATED] Changelog Linker
This package is deprecated. Do you want to take it over or look for replacement? See the issue
Turn your CHANGELOG.md from a machine readable text to a rich text that makes every programmer happy.
Install
Usage
Create changelog-linker.php 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)
You have 4 packages/cateogires options you can use:
Base Branch
Do you want to dump only such pull requests that were merged into a particular branch? Just use base-branch option:
This is very handy when you support multiple versions of your project.
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/easy-coding-standard/.
5. Can I Write Shorter PR Titles?
Just add alias to config:
...and it will be resolved to CodingStandard package.
Report Issues
In case you are experiencing a bug or want to request a new feature head over to the Symplify monorepo issue tracker
Contribute
The sources of this package are contained in the Symplify monorepo. We welcome contributions for this package on symplify/symplify.
All versions of changelog-linker with dependencies
guzzlehttp/guzzle Version ^7.2
nette/utils Version ^3.2
symfony/console Version ^4.4|^5.2
symfony/http-kernel Version ^4.4|^5.2
symfony/process Version ^4.4|^5.2
symplify/package-builder Version ^9.2.6
symplify/smart-file-system Version ^9.2.6
symplify/set-config-resolver Version ^9.2.6
symplify/symplify-kernel Version ^9.2.6