PHP download

Download the PHP package digilive/git-changelog without Composer

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

Table of contents
Download digilive/git-changelog
More information about digilive/git-changelog
Files in digilive/git-changelog

Vendor digilive
Package git-changelog
Short Description Generate a changelog from git commits of the local repository
License BSD-3-Clause

Keywords generator php git changelog

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 digilive/git-changelog

Informations about the package git-changelog

gitChangelog

Generate a changelog from git commits of the local repository.

This library parses information which is stored in a Git repository. From this information, it generates a changelog which can be saved to a file. The information is extracted from the branch which is currently checked out.

Take a look at this example. It is the changelog of the GitChangelog repository, build by this library.

If you have any questions, comments or ideas concerning this library, Please consult the Wiki at first. Create a new issue if your concerns remain unanswered.

Features

Main

Markdown and Html renderers included.
Choose included renderers or create your own.
List Tags and their date.
List unique commit titles per tag.
List commit hashes per unique title (optional).
Include commit titles (and hashes) of the HEAD revision (E.g. Unreleased changes).

Other

Use another local repository as information source.
Set a tag range to limit the changelog.
Filter titles by labels¹.
Set a custom title for the changelog (E.g. a header).
Set a custom title for the HEAD revision (E.g. Next release version).
Set a custom date for the HEAD revision (E.g. Next release date).
Set a custom message to indicate there are no commits present.
In- or exclude merge commits.
Set an ordering key for sorting tags/releases².
Set the sort order of tags/releases.
Set the sort order of titles.

A label is considered to be the first word of a commit title.
Using an invalid key will result in unlisted changes or when enabled, just the changes of the HEAD revision.

Markdown Renderer

Define a custom format for Tag/Release lines.
Define a custom format for title lines.
Format hashes into links to the commit-view of the remote repository provider.
Format issues into links to issue-tracker of the remote repository provider.
Format issues into links to merge-request (aka pull-request) view of the remote repository provider.

Html Renderer

Format hashes into links to the commit-view of the remote repository provider.
Format issues into links to issue-tracker of the remote repository provider.
Format issues into links to merge-request (aka pull-request) view of the remote repository provider.

Installation

The preferred method is to install the library with Composer.

Set the version constraint to a value which suits you best.
Alternatively you can download the latest release from GitHub.

Minimal Example use

Notes

Some options can be changed directly by setting a public property. (Setting a value of an invalid type, might result in unexpected results.)
Others have to be set by calling a method.

Commit guidelines

In order to create a good changelog, you should follow the following guidelines:

Commit messages must have a title line and may have body copy. These must be separated by a blank line.
The title line must not exceed 50 characters.
The title line should be capitalized and must not end in a period.
The title line must be written in an imperative mood (Fix, not Fixed / Fixes etc.).
The body copy must be wrapped at 72 columns.
The body copy must only contain explanations as to what and why, never how. The latter belongs in documentation and implementation.

All versions of git-changelog with dependencies

PHP Build Version

Package Version

Version v2.0.1 Release 02. Oct 2022
create-project require 0 people choosed require and
0 people choosed create-project.

Download

Download latest version of git-changelog from vendor digilive

Requires php Version ^7.3 || ^8.0
ext-mbstring Version *
symfony/process Version ^5

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 digilive/git-changelog contains the following files

Loading the files please wait ....