f3ee0e5726
close #57 Reviewed-on: https://gitea.com/gitea/changelog/pulls/58 Reviewed-by: Andrew Thornton <art27@cantab.net> Reviewed-by: Norwin <noerw@noreply.gitea.io> |
||
|---|---|---|
| cmd | ||
| config | ||
| service | ||
| .changelog.yml | ||
| .drone.yml | ||
| .gitattributes | ||
| .gitignore | ||
| .golangci.yml | ||
| CHANGELOG.md | ||
| LICENSE | ||
| Makefile | ||
| README.md | ||
| changelog.example.go | ||
| changelog.example.yml | ||
| go.mod | ||
| go.sum | ||
| main.go | ||
README.md
Changelog
A changelog generator for Gitea
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 or clone the source and follow the building instructions.
Configuration
See the 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
License
This project is licensed under the MIT License. See the LICENSE file for the full license text.