John Olheiser 601bf3f04c Update installation instructions (#32 )

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>

2020-01-26 22:30:22 +00:00

1.3 KiB

Raw Permalink Blame History

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.

1.3 KiB Raw Permalink Blame History