https://github.com/vexcited/mentor
A tool that automatically bumps the version number, creates a tag, pushes the changes, and generates a GitHub release.
https://github.com/vexcited/mentor
github release release-automation tag version
Last synced: 4 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/vexcited/mentor
- Owner: Vexcited
- License: mit
- Created: 2024-09-21T22:53:25.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-04-28T14:51:40.000Z (about 1 year ago)
- Last Synced: 2025-05-16T08:12:27.781Z (about 1 year ago)
- Topics: github, release, release-automation, tag, version
- Language: Rust
- Homepage:
- Size: 77.1 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Mentor
A very opinionated CLI to quickly release a new version for any GitHub repository.
## Installation
```bash
cargo install --git https://seed.vexcited.com/z3e8pGGtpvezpTJRJqbWb8Ktt7y61.git
```
## Features
- Supports Rust, Swift, Kotlin and JS/TS (`pnpm` and `bun` only)
- Run specific checks depending on the language
- Checks repository state (whether is behind remote or dirty)
- Automatically bumps the version in every files
- Opens a GitHub release link with changelog generated with `git log`
Please, look at the wiki to know the exact configuration your repository must
have for this tool to work correctly.
## 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.