https://github.com/thevickypedia/gitverse-rustic
Rustic version of gitverse
https://github.com/thevickypedia/gitverse-rustic
Last synced: about 2 months ago
JSON representation
Rustic version of gitverse
- Host: GitHub
- URL: https://github.com/thevickypedia/gitverse-rustic
- Owner: thevickypedia
- License: mit
- Created: 2023-11-06T21:48:59.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-13T03:25:41.000Z (4 months ago)
- Last Synced: 2025-02-19T12:12:26.877Z (3 months ago)
- Language: Rust
- Size: 35.2 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GitVerse Rustic
[][rust]
[][build]
Rustic version of [GitVerse][3]
#### Summary
[`gitverse-rustic`][1] is an application written in Rust to create organized release notes.
#### Description
- Uses `git tags` to get all tags for a repository
- Makes GET requests to the repository using GitHub API to fetch release notes
- Organize the release notes in either straight or reverse order
- Requires tag names and release titles to be the same
## Usage
#### Download Executable
```shell
curl -o asset -LH "Accept: application/octet-stream" "https://github.com/thevickypedia/gitverse-rustic/releases/latest/download/asset_gitverse"
```
#### Arguments
- `debug` - Enable on screen logging
- `reverse` - Generate release notes in reverse mode _(last release first)_
#### Flags
- `--filename` / `-f` - Filename for release notes to be stored in
- `--title` / `-t` - Title for the release notes
## Crate
https://crates.io/crates/gitverse
## Linting
### Requirement
```shell
rustup component add clippy
```
### Usage
```shell
cargo clippy --no-deps --fix --allow-dirty
```
## License & copyright
© Vignesh Rao
Licensed under the [MIT License][2]
[1]: https://github.com/thevickypedia/gitverse-rustic
[2]: https://github.com/thevickypedia/gitverse-rustic/blob/main/LICENSE
[3]: https://github.com/thevickypedia/gitverse
[build]: https://github.com/thevickypedia/gitverse-rustic/actions/workflows/rust.yml
[rust]: https://www.rust-lang.org/