https://github.com/sychonet/gitrelease
CLI tool to automatically generate release note and fetch change logs in git projects
https://github.com/sychonet/gitrelease
github gitlab gitrelease
Last synced: 7 days ago
JSON representation
CLI tool to automatically generate release note and fetch change logs in git projects
- Host: GitHub
- URL: https://github.com/sychonet/gitrelease
- Owner: sychonet
- License: apache-2.0
- Created: 2020-07-04T09:35:41.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2022-07-02T14:11:02.000Z (almost 4 years ago)
- Last Synced: 2026-01-15T07:28:30.933Z (6 months ago)
- Topics: github, gitlab, gitrelease
- Language: Go
- Homepage:
- Size: 39.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
CLI tool to automatically generate release note for git projects.
## Overview
In git projects generally while writing release notes for a new tag following steps are used:
* Title for the release is `Releasing `
* Description consists of a list of pull/merge requests merged between previous release and current tag.
The primary objective of this project is to automate the manual work required in above steps. Currently, this project supports following version control systems :
* [Github](https://github.com)
* [Gitlab](https://gitlab.com)
### Github Setup
Steps to generate personal access token on Github :
1. Sign in with your account credentials on [Github](https://github.com/login).
2. Visit [Personal Access Tokens](https://github.com/settings/tokens) and click on `Generate new token` button. A form will appear on your screen.
3. In note field type `Token for synrelease`.
4. Select `repo` scope for the token.
5. Click `Generate token` button at the bottom of form.
6. Copy the token shown on your screen on form submission and use it while configuring this project.
**NOTE : You can revoke the token anytime you want.**
### Gitlab Setup
Steps to generate personal access token on Gitlab :
1. Sign in with your account credentials on [Gitlab](https://gitlab.com/users/sign_in).
2. Visit [Personal Access Tokens](https://gitlab.com/profile/personal_access_tokens),
3. In `Name` field type `Token for synrelease`.
4. Set expiry date for the token in `Expires at` section. If you don't want the token to expire forever then leave that field as blank.
5. Select `api` and `read_api` as scope for the token.
6. Click `Create personal access token` button at the bottom of form.
7. Copy the token shown on your screen on form submission and use it while configuring this project.
**NOTE : You can revoke the token anytime you want.**
### References
* [https://github.com/github/hub/issues/2118](https://github.com/github/hub/issues/2118)
* [https://samrapdev.com/capturing-sensitive-input-with-editor-in-golang-from-the-cli/](https://samrapdev.com/capturing-sensitive-input-with-editor-in-golang-from-the-cli/)
### Contributions
Please fork this repository and open a pull request with your changes.
### License
This is free software, licensed under the Apache-2.0 License.