https://github.com/josemarluedke/go-lib-template
Template/Boilerplate/Blueprint for Go libraries.
https://github.com/josemarluedke/go-lib-template
Last synced: 6 months ago
JSON representation
Template/Boilerplate/Blueprint for Go libraries.
- Host: GitHub
- URL: https://github.com/josemarluedke/go-lib-template
- Owner: josemarluedke
- License: mit
- Created: 2020-01-21T20:52:49.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2019-12-20T13:20:00.000Z (almost 6 years ago)
- Last Synced: 2025-03-28T20:15:33.072Z (6 months ago)
- Homepage:
- Size: 11.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# go-lib-template
Template/Boilerplate/Blueprint for Go libraries.
## Installation
```sh
go install github.com/tmrts/boilr
boilr template download -f neighborly/go-lib-template go-lib
```
## Usage
```sh
boilr template use go-lib
```
## Features
- [Release Drafter](https://github.com/toolmantim/release-drafter) using GitHub Actions.
- Travis CI.
- Go Modules
- Test suite using [Ginkgo](https://github.com/onsi/ginkgo).
- Readme & License.
- [EditorConfig](https://editorconfig.org/).
## GitHub Labels
We use a template for GitHub Labels. We use labels to guide changelog
generation and better understanding what is changing in Pull Requests.
### Install the CLI
We use the [github-label-sync](https://github.com/Financial-Times/github-label-sync) node package to sync labels to a GitHub repository.
```sh
npm install -g github-label-sync
```
### GitHub Access Token
Obtain a [GitHub personal access token](https://help.github.com/en/articles/creating-a-personal-access-token-for-the-command-line).
This is necessary for `github-label-sync` to access our GitHub repositories.
### Sync
Execute the following command to sync the labels:
```
github-label-sync --labels https://gist.githubusercontent.com/josemarluedke/984cbae3435a18818a5ae5d8aa44ff60/raw/github-labels.json --access-token neighborly/
```
## License
This project is licensed under the [MIT License](LICENSE.md).