Skip to content

waldirborbajr/gitrelease

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

72 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

GitRelease - DevOps Automation Command Line Tool

Lint CI Release Security audit Release to crates.io

Overview

A simple command line tool written in Rust programming language. It automates the process of generating new releases. This tool is designed to streamline the Git workflow, making it faster and more convenient.

Usage

To use GitRelease, follow these steps:

  1. Navigate to the root directory of your Git repository in the terminal.

  2. Run the following command:

gitrelase

This command will execute the tool and perform the following operations:

  1. Add all files recursively to the Git repository.
  2. Commit all changes with a randomly generated commit message.
  3. Push the changes to the remote repository (origin main branch).

Installation

Pre-Built Binary

Each release comes with pre-built binaries of several platforms. Grab it from Github Releases.

From source

Make sure you have Rust installed, then:

To build and install this, you'll need Rust and Cargo installed on your system. If you haven't already, you can install Rust by following the instructions on the official Rust website.

Once Rust is installed, you can proceed with the following steps:

  1. Clone the repository:
git clone https://github.com/waldirborbajr/gitrelease.git
  1. Navigate to the project directory:
cd gitrelease
  1. Build the project using Cargo:
cargo build --release
  1. Install the binary:
cargo install --path .

Dependencies

  • names: This dependency is used to generate random commit messages. You can find more information about this crate here.

  • std::os: This module is part of the Rust standard library and is used for interacting with the operating system. It is used in this project for handling process exit codes.

Contributing to GitRelease

If you are interested in contributing to GitRelease, we would love to have your help! You can start by checking out the open issues on our GitHub repository to see if there is anything you can help with. You can also suggest new features or improvements by opening a new issue.

To contribute code to GitRelease, you will need to fork the repository and create a new branch for your changes. Once you have made your changes, you can submit a pull request for them to be reviewed and merged into the main codebase.

License

This project is released under the MIT License - see the LICENSE file for details.