Download the PHP package decodelabs/chronicle without Composer
On this page you can find all versions of the php package decodelabs/chronicle. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
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 chronicle
Chronicle
Release notes generator
Chronicle provides a set of tools for parsing, generating and rendering release notes and change logs.
Installation
Install via Composer:
Usage
Open a Repository in the root of your project - if you don't pass a path, the repository will use your project root defined via Monarch.
Parse your existing change log file - name defaults to CHANGELOG.md. Set rewrite to true to reformat release headers and layout in Chronicle's format - useful for converting existing change logs.
If your change log file doesn't exist, an empty template document will be created.
Structure
The parser expects three main sections in the change log file:
- Preamble: This is the first section of the file, which contains general information about the change log
- Unreleased: This section contains unreleased changes, which are not yet assigned to a specific version
- Releases: This section contains the list of released versions, each with its own set of changes
Next release
You can add unreleased changes to the change log in the Unreleased section as you work on your project. When you're ready to release a new version, you can use the generateNextRelease() method to turn those changes into a new release.
if your project is hosted on GitHub, generateNextRelease() will automatically fetch the latest issues and pull requests from the repository and add them to the release notes.
if your project is private or you hit the API rate limit, you can place your access token in your .env file with the key GITHUB_TOKEN. Chronicle will automatically authenticate with the GitHub API using this token.
Rendering
You can render the change log document to a string using the render() method, or back to the original file using save(). When you call either of these methods, you can specify a Renderer implementation which you can use to customize the output format. If ommitted, the default renderer will be used.
Licensing
Chronicle is licensed under the MIT License. See LICENSE for the full license text.
All versions of chronicle with dependencies
decodelabs/atlas Version ^0.13
decodelabs/dovetail Version ^0.2.12
decodelabs/enumerable Version ^0.2.1
decodelabs/exceptional Version ^0.6
decodelabs/monarch Version ^0.1.3
decodelabs/stash Version ^0.6.3
decodelabs/systemic Version ^0.11.16
nesbot/carbon Version ^3.9
guzzlehttp/guzzle Version ^7.0.1
http-interop/http-factory-guzzle Version ^1.0
knplabs/github-api Version ^3.0
z4kn4fein/php-semver Version ^3.0