https://github.com/literateink/mentor
A tool that automatically bumps the version number, creates a tag, pushes the changes, and generates a GitHub release.
https://github.com/literateink/mentor
github release release-automation tag version
Last synced: 10 months ago
JSON representation
A tool that automatically bumps the version number, creates a tag, pushes the changes, and generates a GitHub release.
- Host: GitHub
- URL: https://github.com/literateink/mentor
- Owner: LiterateInk
- License: mit
- Created: 2024-09-21T22:53:25.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-05T21:30:01.000Z (10 months ago)
- Last Synced: 2025-04-08T08:22:07.058Z (10 months ago)
- Topics: github, release, release-automation, tag, version
- Language: Rust
- Homepage:
- Size: 107 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Mentor
A simple CLI to quickly release a new version.
> This tool was intentionally made for LiterateInk repositories but can be used in any repository that follows the same conventions.
## Motivation
In some implementations, such as JS, we had custom tools to do this but it was only bound to that specific implementation. For example, `release-it` for the JS implementation. But, I wanted a tool that could be used in any implementation without doing any extra config, work or setup.
So, we created this tool to automate the process without any configuration or setup. It's a simple CLI tool that can be used in any of our library repositories to quickly release a new version.
## Build
You can only install it by building it from source.
Make sure you have `cargo` and `rust` installed.
```bash
cargo build --release
```
## Installation
```bash
# If you cloned the repository...
cargo install --path .
# If you want to install it from GitHub...
cargo install --git https://github.com/LiterateInk/Mentor
```
This will install the `mentor` binary in your `$PATH`.
## Usage
Be in a repository and directly run this command.
```bash
mentor
```
It'll ask you for the type of bump you want for the new version, and then it'll create a new commit and tag and push it to the current branch.
It'll also redirect you to the GitHub page to create a new release with the tag, release name and the release notes - generated using a `git log`.
> By the way, this project itself uses Mentor to release new versions. So, you can see how it works in action.
## License
This project is licensed under the MIT License - see the [LICENSE](./LICENSE) file for details.