Download the PHP package ergebnis/github-changelog without Composer
On this page you can find all versions of the php package ergebnis/github-changelog. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download ergebnis/github-changelog
More information about ergebnis/github-changelog
Files in ergebnis/github-changelog
Package github-changelog
Short Description Provides a console command that generates a changelog based on titles of pull requests merged between specified references.
License MIT
Homepage https://github.com/ergebnis/github-changelog
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 github-changelog
github-changelog
Provides a script that generates a changelog based on titles of pull requests merged between specified references.
Is this the right tool for me?
Probably not. There are a range of other tools that probably do a better job.
Take a look at
- https://packagist.org/?q=changelog
- https://www.npmjs.com/search?q=changelog
- https://pypi.python.org/pypi?%3Aaction=search&term=changelog
Nonetheless, for me and my projects, it's the second best thing after manually keeping a changelog as suggested at http://keepachangelog.com.
When will it work for me?
| My process | Will this tool work for me? |
|---|---|
| I need elaborate changelogs | No |
| I push directly into the default branch | No |
 |
No |
 |
No |
 |
Yes |
Why is this tool so limited?
All this tool does is this:
- it collects commits between references
- it matches commit messages against what is used by GitHub as a merge commit message
- it fetches the pull request title from the corresponding pull request
- it then uses all of the pull request titles to compile a list
CLI Tool
Global installation
Install globally:
Create your changelogs from within a Git repository:
Create your changelogs from anywhere, specifying the repository using the --repository option:
Enjoy the changelog:
Local installation
Install locally:
Create your changelog from within in your project:
Enjoy the changelog:
Userland Code
Install locally:
Retrieve pull requests between references in your application:
Enjoy the changelog:
Hints
:bulb: You can use anything for a reference, e.g., a tag, a branch, a commit!
Changelog
Please have a look at CHANGELOG.md.
Contributing
Please have a look at CONTRIBUTING.md.
Code of Conduct
Please have a look at CODE_OF_CONDUCT.md.
License
This package is licensed using the MIT License.
Please have a look at LICENSE.md.
Curious what I am building?
:mailbox_with_mail: Subscribe to my list, and I will occasionally send you an email to let you know what I am working on.
All versions of github-changelog with dependencies
knplabs/github-api Version ^2.12.1
php-http/guzzle6-adapter Version ^1.1.1
symfony/cache Version ^4.3.8
symfony/console Version ^4.3.8
symfony/stopwatch Version ^4.4.1