Download the PHP package wnx/changelog-updater without Composer

On this page you can find all versions of the php package wnx/changelog-updater. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

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 PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • 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.
Please rate this library. Is it a good library?

Example code of wnx/changelog-updater

Informations about the package changelog-updater

changelog-updater

A PHP CLI to update a changelog with the latest release notes.

Latest Version on Packagist Tests Check & fix styling phpstan Total Downloads

Want to automate the process of updating your changelog with GitHub Actions? Checkout the stefanzweifel/changelog-updater-action which does exactly that.

If your changelog follows the "Keep a Changelog" format and has a "Unreleased" heading in it, the CLI will update the link in and place the release notes below heading.

Installation

You can install the changelog-updater CLI as a composer dependency in your project or globally. It requires PHP 8.2 or higher.

Usage

You can use changelog-updater by running the update command with the following options.

--release-date, --path-to-changelog, --compare-url-target-revision and --write are optional. Learn more about the options by running php changelog-updater update --help.

If a given version already exists in the CHANGELOG, the CLI will display a warning and not update the CHANGELOG.

CLI Options

--release-notes

Required. The release notes you want to add to your changelog. Should be markdown.

--latest-version

Required. Version number of the latest release. The value will be used as the heading text if --heading-text is not set. If the changelog has a "Unreleased" heading, the value will be used in the updated compare URL.

Example: v1.0.0

--release-date

Optional (Defaults to current date). The date the latest version has been released. The value will be used in the release heading.

--path-to-changelog

Optional (Defaults to CHANGELOG.md). Path to CHANGELOG.md file.

--compare-url-target-revision

Optional (Defaults to HEAD). If the changelog has a "Unreleased" heading, the value will be used together with the --latest-version value in the updated compare URL.

--write

Optional. Write the changes to CHANGELOG.md or to the value of --path-to-changelog.

--github-actions-output

Optional. Will output values for UNRELEASED_COMPARE_URL and RELEASE_COMPARE_URL that can be picked up by GitHub Actions and further used in ones Workflow.

--heading-text

Optional (Defaults to value of --latest-version). The text value used in the heading that is created for the new release.

--parse-release-notes

Optional. Tell the CLI explicitly to use the content between an "Unreleased Heading" and the previous version heading as release notes. The value from --release-notes will be ignored.

--hide-release-date

Optional. Don't add the release date to the release heading.

--parse-github-usernames

Optional. Look for GitHub usernames in --release-notes and linkify them. Currently not supported for release notes that are located in the existing changelog.

Expected Changelog Formats

The CLI does its best to place the given release notes in the right place. The CLI looks for the first second level heading in your current CHANGELOG.md file. It assumes that this heading represents the previous version. Here is an example of a CHANGELOG.md that the CLI can understand.

The CLI will then place the new version and its release notes above the existing versions.

If the changelog does not contain a second level heading, it considers the changelog to be "empty". It will then place the release notes at the bottom of the document.

If your changelog follows the "Keep a Changelog" format and contains an "Unreleased"-heading with a link to the repository compare view, the CLI will automatically update the link in the Unreleased heading.

Here is an example of a changelog, before it is updated with the CLI.

Below you find a diff-view of how the CLI will update the changelog.

The content between the "Unreleased"-heading and the latest version will remain untouched by the CLI.

If you don't have a "Unreleased"-heading in your changelog, but the headings of your previous releases contain a link to the repository compare view, the CLI will add links to the compare view to the added release heading.

Testing

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.

All versions of changelog-updater with dependencies

PHP Build Version
Package Version
Requires php Version ^8.2
ext-dom Version *
league/commonmark Version ^2.3.5
webmozart/assert Version ^1.11
wnx/commonmark-markdown-renderer Version ^1.0.2
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package wnx/changelog-updater contains the following files

Loading the files please wait ....