https://github.com/ironpeakservices/iron-go-project

A repository template to start your new Go project on GitHub, batteries included.
https://github.com/ironpeakservices/iron-go-project

go iron project template

Last synced: 10 months ago
JSON representation

A repository template to start your new Go project on GitHub, batteries included.

• Host: GitHub
• URL: https://github.com/ironpeakservices/iron-go-project
• Owner: ironpeakservices
• License: apache-2.0
• Created: 2020-05-28T08:56:26.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2023-04-14T04:56:48.000Z (about 3 years ago)
• Last Synced: 2025-05-01T11:37:20.257Z (about 1 year ago)
• Topics: go, iron, project, template
• Language: Makefile
• Homepage:
• Size: 124 KB
• Stars: 12
• Watchers: 2
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          

# iron-go-project

A repository template to start your new Go project on GitHub, batteries included.

## How to use

1. Click the green button "Use this template" to copy this over.

2. Change go.mod to your own module path.

3. Potentially change the LICENSE as you please. Check out [tl;dr legal](https://tldrlegal.com).

4. Enable "dependabot alerts" in the Security tab.

5. Setup Branch protection rules to disallow pushing to master or dev.

6. Develop in a feature branch, merge to `dev` and later to `master`.

7. `make` and enjoy!

## Features

- `.gitignore` for go development.

- [GitHub dependabot](https://github.com/features/security) configured by default. ([including for Go!](https://github.com/ironPeakServices/iron-go-project/tree/master/.github/go))

- [golangci](https://github.com/golangci/golangci-lint) linting enabled by default.

- Semantic releases are automatically tagged on push to master.

- [goreleaser](https://github.com/goreleaser/goreleaser/) releases Go builds on new tags.

- [gobenchmark](https://github.com/cornelk/go-benchmark) configured by default to track your performance across commits.

- ToDos are automatically converted into GitHub issues.