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 <tag>
• 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
• Gitlab

Github Setup

Steps to generate personal access token on Github :

1. Sign in with your account credentials on Github.
2. Visit Personal Access 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.
2. Visit 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://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.