github.com/arsham/gitrelease@v0.3.2-0.20221207124258-6867180b2c2d/README.md (about) 1 # Gitrelease 2 3 [![Continues Integration](https://github.com/arsham/gitrelease/actions/workflows/go.yml/badge.svg)](https://github.com/arsham/gitrelease/actions/workflows/go.yml) 4 ![License](https://img.shields.io/github/license/arsham/gitrelease) 5 6 This program can set the release information based on all commits of a tag. To 7 see the example visit [Releases](https://github.com/arsham/gitrelease/releases) 8 page. 9 10 1. [Requirements](#requirements) 11 2. [Installation](#installation) 12 3. [Usage](#usage) 13 4. [License](#license) 14 15 ## Requirements 16 17 This program requires `Go >= v1.17`. 18 19 Uses your github token with permission scope: **repo** 20 21 ## Installation 22 23 To install: 24 25 ```bash 26 go install github.com/arsham/gitrelease@latest 27 ``` 28 29 Export your github token: 30 `export GITHUB_TOKEN="ghp_yourgithubtoken"` 31 32 ## Usage 33 34 After you've made a tag, you can publish the current release documents by just 35 running: 36 37 ```bash 38 gitrelease 39 ``` 40 41 If you want to release an old tag: 42 43 ```bash 44 gitrelease -t v0.1.2 45 ``` 46 47 If you want to use a different remote other than the `origin`: 48 49 ```bash 50 gitrelease -r upstream 51 ``` 52 53 ## License 54 55 Licensed under the MIT License. Check the [LICENSE](./LICENSE) file for details. 56 57 <!-- 58 vim: foldlevel=1 59 -->