felixdorn/release-that

This package is abandoned and no longer maintained. No replacement package was suggested.

Automated release system for PHP

Installs: 149

Dependents: 2

Suggesters: 0

Security: 0

Stars: 3

Watchers: 2

Forks: 0

Language:Go

14.45.12 2021-03-06 09:00 UTC

README

Rt, short for release that, is a tool for quickly creating GitHub releases.

Installation

curl -L https://github.com/felixdorn/rt/releases/latest/download/rt -o rt
chmod +x ./rt
mv ./rt /usr/bin/rt

Once you have installed the binary, you'll need to login to GitHub.

rt --login

Your personal access token is stored in ~/.rtauth with restricted permissions (0644).

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:

rt --init

The default configuration can be found here, it looks like this:

{
  "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

Usage

You can release a new version with the following command:

rt --patch
rt --minor
rt --major
rt --custom 4.24.5-linux+stripped 

The custom version must be a valid semver version.