README
¶
template-go
A GitHub template repository for Go
Prerequisites
Development instructions
Local development
Use Makefile to run the project locally.
# help
make
# install dependencies for development
make install-deps-dev
# run tests
make test
# build applications
make build
# run CI tests
make ci-test
# release applications
make release
Docker development
# build docker image
make docker-build
# run docker container
make docker-run
# run CI tests in docker container
make ci-test-docker
Deployment instructions
Docker Hub
To publish the docker image to Docker Hub, you need to create access token and set the following secrets in the repository settings.
gh secret set DOCKERHUB_USERNAME --body $DOCKERHUB_USERNAME
gh secret set DOCKERHUB_TOKEN --body $DOCKERHUB_TOKEN
Documentation
¶
Overview ¶
Copyright © 2024 ks6088ts
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Source Files
Directories