An open API service indexing awesome lists of open source software.

https://github.com/agateau/releasetools

Command-line tools to help releasing software
https://github.com/agateau/releasetools

Last synced: 9 months ago
JSON representation

Command-line tools to help releasing software

Awesome Lists containing this project

README

          

# Releasetools

## Assumptions

- Currently released version can be obtained from the latest git tag.
- Git is in $PATH.
- Tags are created on a "main" branch.
- Releases are prepared on a "work" branch.

## Commands

### rlt-version

- Print released version with `rlt-version --released`.
- Print next version with `rlt-version --next`.
- Set next version with `rlt-version --set-next `.

### rlt-changelog

Prints a summary of the changes between the released version and HEAD.

### rlt-updateworkbranch

Makes sure work branch is up to date.

### rlt-tag

Creates tag for the next version.

## releasetools.toml

Create this file in the root directory of your project to customize Releasetools behavior.

```
[git]
main_branch="master"
tag_prefix=""
work_branch="dev"

[version]
file="CMakeLists.txt"
pattern="^ VERSION (.*)$"

[changelog]
git_log_options="--pretty=format:- \\%s (\\%an)"
```