Skip to content

Latest commit

 

History

History
102 lines (72 loc) · 3.62 KB

GET_STARTED.md

File metadata and controls

102 lines (72 loc) · 3.62 KB
sidebar_position
1

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.

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
  • Blazing fast, no wait
  • Workspace support out-of-box
  • Programming language agnostic
  • Fast (<5 sec with all plugins execution)
  • Plugins available/compatible
  • Presets available/compatible

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

Inspirations

Credits to

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

as well as

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

also to

for amazing documentation tool

and more

License

GPL-3