This is a template for Go CLI tools. Major features are:
- Setup script
- Release build action
- PR validation action
- Code of Conduct
- Basic security policy
- Modules enabled
- Rudimentary accepance tests
- Create a new repo from this template
$ ./setup.sh- Follow the prompts
Use the -d option to see what will be modified without changing any files.
You can delete everything above this line afterwards.
One Paragraph of project description goes here
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
What things you need to build the software and how to install them:
tparse helps to turn verbose default Go testing output something more friendly.
go install github.com/mfridman/tparse@latestInstructions for installing the linter can be found here.
$ git clone http://github.com/dnnrly/goclitem.git
$ cd goclitem
$ make install$ make test$ make deps
$ make build acceptance-testacceptance-test- run acceptance testsbuild- build the applicationci-test- ci target - run tests to generate coverage datacoverage-report- collate the coverage datagenerate- generate mocks and other assetshelp- print help messagelint- run linting with golangci-linttest- run unit tests with tparse
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
We use SemVer for versioning. For the versions available, see the tags on this repository.
- Your name here - Initial work - dnnrly
See also the list of contributors who participated in this project.
This project is licensed under the Apache 2.0 License - see the LICENSE file for details
- Important people here