Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/waldirborbajr/gitrelease
GitRelease - DevOps Automation Command Line Tool
https://github.com/waldirborbajr/gitrelease
cli command-line devops gitrelease hacktoberfest rust terminal
Last synced: 9 days ago
JSON representation
GitRelease - DevOps Automation Command Line Tool
- Host: GitHub
- URL: https://github.com/waldirborbajr/gitrelease
- Owner: waldirborbajr
- License: mit
- Created: 2023-11-07T00:23:43.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-11T21:20:15.000Z (3 months ago)
- Last Synced: 2024-11-15T06:31:37.874Z (2 months ago)
- Topics: cli, command-line, devops, gitrelease, hacktoberfest, rust, terminal
- Language: Rust
- Homepage:
- Size: 78.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GitRelease - DevOps Automation Command Line Tool
[](https://github.com/waldirborbajr/gitrelease/actions/workflows/linter.yaml) [](https://github.com/waldirborbajr/gitrelease/actions/workflows/ci.yaml)
[](https://github.com/waldirborbajr/gitrelease/actions/workflows/release.yaml)
[](https://github.com/waldirborbajr/gitrelease/actions/workflows/audit.yaml)
[](https://github.com/waldirborbajr/gitrelease/actions/workflows/crates.yaml)
## 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:
```bash
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](https://github.com/waldirborbajr/gitrelease/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](https://www.rust-lang.org/tools/install).
Once Rust is installed, you can proceed with the following steps:
1. Clone the repository:
```bash
git clone https://github.com/waldirborbajr/gitrelease.git
```
2. Navigate to the project directory:
```bash
cd gitrelease
```
3. Build the project using Cargo:
```bash
cargo build --release
```
4. Install the binary:
```bash
cargo install --path .
```
## Dependencies
- `names`: This dependency is used to generate random commit messages. You can find more information about this crate [here](https://crates.io/crates/names).
- `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 ](https://github.com/waldirborbajr/gitrelease/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](LICENSE) file for details.