2020-01-09 07:43:20 +00:00
# Changelog
2022-09-16 09:31:37 +00:00
2020-01-09 07:43:20 +00:00
A changelog generator for Gitea
2017-08-25 06:52:51 +00:00
2020-01-09 07:43:20 +00:00
[![Build Status ](https://drone.gitea.com/api/badges/gitea/changelog/status.svg )](https://drone.gitea.com/gitea/changelog)
2017-08-25 06:52:51 +00:00
## Purpose
2020-01-09 07:43:20 +00:00
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.
2017-08-25 06:52:51 +00:00
## Installation
2020-01-26 22:30:22 +00:00
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 ).
2017-08-25 06:52:51 +00:00
## Configuration
2022-06-22 01:27:24 +00:00
See the [changelog.example.yml ](config/changelog.example.yml ) example file.
2017-08-25 06:52:51 +00:00
## Usage
2022-09-16 09:31:37 +00:00
### Changelog Entries
2020-01-09 07:43:20 +00:00
2022-09-16 09:31:37 +00:00
```sh
changelog generate -m=1.11.0 -c=/path/to/my_config_file
2020-01-09 07:43:20 +00:00
```
2022-09-16 09:31:37 +00:00
### Contributors List
```sh
changelog contributors -m=1.11.0 -c=/path/to/my_config_file
2020-01-09 07:43:20 +00:00
```
## Building
2022-09-16 09:31:37 +00:00
```sh
2020-01-09 07:43:20 +00:00
go build
2017-08-25 06:52:51 +00:00
```
## Contributing
Fork -> Patch -> Push -> Pull Request
## Authors
2020-01-09 07:43:20 +00:00
* [Maintainers ](https://gitea.com/org/gitea/members )
* [Contributors ](https://gitea.com/gitea/changelog/commits/branch/master )<!-- FIXME when contributors page works -->
2017-08-25 06:52:51 +00:00
## License
2020-01-09 07:43:20 +00:00
This project is licensed under the MIT License. See the [LICENSE ](LICENSE ) file for the full license text.