Download the PHP package zenstruck/changelog without Composer
On this page you can find all versions of the php package zenstruck/changelog. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download zenstruck/changelog
More information about zenstruck/changelog
Files in zenstruck/changelog
Package changelog
Short Description Generate pretty release changelogs using the commit log and Github API.
License MIT
Homepage https://github.com/zenstruck/changelog
Informations about the package changelog
zenstruck/changelog
Generate pretty release changelogs using the commit log and Github API. Changelog entries are in the following format:
Some notes about the format:
- Currently, this format is hard-coded and can't be customized
- Merge commits are excluded
- PR number is only added if not already in the summary (and a PR exists for the commit)
- Author/Co-Author's are converted to GitHub username links if possible to take advantage of GitHub Release Avatar List
See an example of a release generated using this package.
Installation
To avoid dependency conflicts with this tool, it is recommended to install as an executable PHAR or install in your project (or globally) using the composer bin plugin.
PHAR
Composer Bin Plugin
Requires the bamarni/composer-bin-plugin.
Configuration
The changelog
binary should be executable either globally or via vendor/bin/changelog
. For the remainder of this
documentation, it is assumed this is available as changelog
.
This tool requires a GitHub Personal Access Token to access the GitHub API. You can configure this in two ways:
GITHUB_API_TOKEN
environment variable (ie prefixchangelog
commands withGITHUB_API_TOKEN=your-token
)- Configure the token globally:
changelog configure
and follow the instructions to generate/save your token
Usage
Note: Commands that detect the repository from your current directory use the
upstream
origin if available.
Changelog Preview
Generate a changelog preview in your console:
Run changelog generate --help
to see full command documentation.
Create Changelog File
Create a CHANGELOG.md
file for the current repository based on existing releases. This
file is created in the current working directory. It is up to you to add/commit to the repository.
Create Release
Create (and optionally push) a release changelog (exclude --push
to preview what the release will look like):
You can use semantic versioning keywords as the next version. The following example assumes your last release was v1.0.0.
Run changelog release --help
to see full command documentation.
Release Status Dashboard
Generate a simple dashboard for a GitHub organization showing package release statuses.
If you have repositories that have workflows disabled due to inactivity, you
can use the --enable-workflows
option to enable them.
All versions of changelog with dependencies
composer/semver Version ^3.4.3
laravel-zero/phar-updater Version ^1.4.2
symfony/cache Version ^5.4.46
symfony/console Version ^5.4.47
symfony/filesystem Version ^5.4.45
symfony/http-client Version ^5.4.49