Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/digilive/gitchangelog
Generate a changelog from git commits of the local repository
https://github.com/digilive/gitchangelog
Last synced: 3 months ago
JSON representation
Generate a changelog from git commits of the local repository
- Host: GitHub
- URL: https://github.com/digilive/gitchangelog
- Owner: DigiLive
- License: bsd-3-clause
- Created: 2020-10-18T14:13:08.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-10-02T20:34:37.000Z (over 2 years ago)
- Last Synced: 2024-09-22T10:47:56.126Z (4 months ago)
- Language: PHP
- Size: 134 KB
- Stars: 7
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# gitChangelog
[](https://github.com/DigiLive/gitChangelog/releases)
[](https://opensource.org/licenses/BSD-3-Clause)
[](https://www.codacy.com/gh/DigiLive/gitChangelog/dashboard?utm_source=github.com&utm_medium=referral&utm_content=DigiLive/gitChangelog&utm_campaign=Badge_Grade)
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](CHANGELOG.md). 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](https://github.com/DigiLive/gitChangelog/wiki) at first.
Create a new [issue](https://github.com/DigiLive/gitChangelog/issues/new) 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 labels1.
* 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/releases2.
* Set the sort order of tags/releases.
* Set the sort order of titles.
1. A label is considered to be the first word of a commit title.
2. 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](http://getcomposer.org).
```sh
> composer require digilive/git-changelog:^2
```
Set the version constraint to a value which suits you best.
Alternatively you can download the latest release
from [GitHub](https://github.com/DigiLive/gitChangelog/releases).
## Minimal Example use
```php
build();
$content = $changelog->get();
```
## 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.