forked from gitea/changelog
John Olheiser
601bf3f04c
Update installation instructions Signed-off-by: jolheiser <john.olheiser@gmail.com> Co-authored-by: jolheiser <john.olheiser@gmail.com> Reviewed-on: gitea/changelog#32 Reviewed-by: 6543 <6543@noreply.gitea.io> Reviewed-by: lafriks <lafriks@noreply.gitea.io>
50 lines
1.3 KiB
Markdown
50 lines
1.3 KiB
Markdown
# Changelog
|
|
A changelog generator for Gitea
|
|
|
|
[](https://drone.gitea.com/gitea/changelog)
|
|
|
|
## Purpose
|
|
|
|
This repo is currently part of Gitea. The purpose of it is to generate a changelog when writing release notes.
|
|
This project was made for Gitea, so while you are free to use it in your own projects, it is subject to change with Gitea.
|
|
This tool generates a changelog from PRs based on their milestone and labels.
|
|
|
|
## Installation
|
|
|
|
Download a pre-built binary from our [downloads page](https://dl.gitea.io/changelog-tool/) or clone the source and follow the [building instructions](#building).
|
|
|
|
## Configuration
|
|
|
|
See the [changelog.example.yml](changelog.example.yml) example file.
|
|
|
|
## Usage
|
|
|
|
#### Changelog Entries
|
|
```
|
|
changelog -m=1.11.0 -c=/path/to/my_config_file generate
|
|
```
|
|
|
|
#### Contributors List
|
|
```
|
|
changelog -m=1.11.0 -c=/path/to/my_config_file contributors
|
|
```
|
|
|
|
## Building
|
|
```
|
|
go generate ./...
|
|
go build
|
|
```
|
|
|
|
## Contributing
|
|
|
|
Fork -> Patch -> Push -> Pull Request
|
|
|
|
## Authors
|
|
|
|
* [Maintainers](https://gitea.com/org/gitea/members)
|
|
* [Contributors](https://gitea.com/gitea/changelog/commits/branch/master)<!-- FIXME when contributors page works -->
|
|
|
|
## License
|
|
|
|
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for the full license text.
|