Getting Started

Welcome to release-me! This tool is designed to streamline your software release process, making it easier to manage versions, changelogs, and deployment. Whether you're working on a small project or a large enterprise application, release-me is here to simplify your workflow.

Quick Start

info

You do not need compile, install dependencies or other actions

It is easy to get-started in two steps if we do basic steps:

1. Clone repo with within folder into your project, see Installation for other methods
2. Run .release-me/release.sh to run with default options, see Usage for more info about options

Prerequisites

Before you start using release-me, make sure you have the following installed on your system:

• git (version 2.30 or later)
• bash (version 5.x or later) with curl, sed dependencies
• npm (version 9.x or later), required for npm package

Features

• Available on all Unix environments
• Zero third-party dependencies
• No pre-install, just use
• Fast and no wait
• Workspace support out-of-box
• Programming language agnostic
• Fast (<5 sec with all plugins execution)
• Plugins available/compatible
• Presets available/compatible
• Free and permissive license

Limitations

• Currently supports only Node.js, Rust and Python projects (library only)
• Rebased commits tracking are lost so duplicate releases possible
• Available only in Unix environments (no Windows support yet)

Versioning priority

If one of files described below will be found, script parse first matched file and priority will ran as these

1. Node.js (package.json)
2. Rust (Cargo.toml)
3. Python (setup.py)

Comparison

Features	release-me	semantic-release	go-semantic-release
Performance	Fast	Slow	Fast
Startup delay	-	Slow	Fast
Platform	Unix-only	ALL	ALL
Dependencies	-	+	?
Configuration	-	+	+
Presets	+	+	-
Plugins	+	+	+
Workspaces	Built-in	?	-
0.x support	Built-in	-	?
semver	+	+	+

Similar projects

• semantic-release
• go-semantic-release
• changesets
• release-please

Inspirations

• semantic-release-bash
• semantic-release.sh
• conventional-commit-version-parser
• publish.sh

Credits to

for making project safer with testing, coverage and linting entire project

• Bash
• ShellCheck
• Bashcov
• bash_unit

as well as

for keeping project safe, catching early bugs and more useful tasks on local development

• typos
• lefthook
• biome
• dprint
• commitlint-rs
• ls-lint

also to

for amazing documentation tool

• docusaurus

and more

License

Apache-2.0