Skip to content

Latest commit

 

History

History
107 lines (76 loc) · 2.42 KB

README.md

File metadata and controls

107 lines (76 loc) · 2.42 KB
Raw

Rt

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

Installation

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.

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:

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
  • before_release:
    • :tag / :version
    • :commit
    • :longCommit
  • after_release:
    • :tag / :version
    • :commit
    • :longCommit

Usage

You can release a new version with the following command:

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.