https://github.com/felixdorn/release-that
Automated release system for GitHub repositories.
https://github.com/felixdorn/release-that
bump git publish release-automation release-helper semver tool
Last synced: 7 months ago
JSON representation
Automated release system for GitHub repositories.
- Host: GitHub
- URL: https://github.com/felixdorn/release-that
- Owner: felixdorn
- Created: 2020-02-18T11:07:39.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2025-01-05T17:57:27.000Z (10 months ago)
- Last Synced: 2025-02-05T21:07:48.791Z (8 months ago)
- Topics: bump, git, publish, release-automation, release-helper, semver, tool
- Language: Go
- Homepage:
- Size: 3.06 MB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Rt
> Just testing go.
Rt, short for release that, is a tool for quickly creating GitHub releases.
## Installation
```bash
curl -L https://github.com/felixdorn/release-that/releases/latest/download/release-that -o /usr/bin/rt
chmod +x /usr/bin/rt
```
Once you have installed the binary, you'll need to login to GitHub.
```bash
rt --login
```
Your personal access token is stored in `~/.rtauth` with restricted permissions (0600).
## Configuration
`rt` can work without any configuration, however if you want to customize the release name, contents..., you can create
one with the following command:
```bash
rt --init
```
The default configuration can be found [here](_config.json), it looks like this:
```json
{
"release_notes": {
"title": "Release :version",
"commit_format": "* :hash: :message"
},
"before_release": [],
"after_release": [],
"assets": [],
"tag_message": "Version :tag"
}
```
`before_release` and `after_release` are an array of commands that will be executed before and after the release
process.
`assets` is an array of files that will be uploaded along with the release.
You can use various placeholders in the following keys:
* tag_message:
* `:tag` / `:version`
* release_notes.title:
* `:tag` / `:version`
* release_notes.commit_format:
* `:hash`
* `:longHash`
* `:message`
* `:author.name`
* `:author.email`
* before_release:
* `:tag` / `:version`
* `:commit`
* `:longCommit`
* after_release:
* `:tag` / `:version`
* `:commit`
* `:longCommit`
## Usage
You can release a new version with the following command:
```bash
rt --patch # rt -p
rt --minor # rt -m
rt --major # rt -M
rt --custom 4.24.5-linux+stripped
```
The custom version must be a valid semver version.
* `--skip-hooks`
Skips the execution of the `before_release` and `after_release` hooks. You may specify which hooks to
skip `--skip-hooks before_release,after_release`. You may also pass `no` to run every hook (the default).
* `-q, --quiet`
Suppresses the output of the release process, the only thing printed is the released version.
* `-D, --dry-run`
Prints the release notes and the release tag, but does not actually create the release.
* `-Q, --no-ansi`
Disables ANSI colors in the output.
* `-u, --self-update`
Updates the `rt` binary to the latest version.
* `-v, --version`
Prints the current version of `rt`.