Skip to content

Latest commit

 

History

History
79 lines (62 loc) · 3.12 KB

README.md

File metadata and controls

79 lines (62 loc) · 3.12 KB
Raw

golang AIP server demo

Practices for implementing Google API Improvement Proposals (AIP) in Go.

Apply knowledge and experience to improve open source

Dependencies

This project uses bingo (located in .bingo/), a tool to automate the versioning of Go packages.

Run make install-build-deps to install dependencies tools.

❯ make help

Usage:
  make <target>

Build
  build                                     Build binary for current OS and place it at ./bin/gaip_$(GOOS)_$(GOARCH)
  build-all                                 Build binaries for Linux and Mac and place them in dist/
  clean                                     Remove artefacts or generated files from previous build

Dependencies
  check-go-mod                              Ensures fresh go.mod and go.sum.
  install-build-deps                        Install dependencies tools

Ent Schema
  ent-gen                                   Regenerate schema
  ent-describe                              Get a description of graph schema
  atlas-lint                                Verifying and linting migrations

Regenerate gRPC Code
  protoc-install                            Install proper protoc version
  protoc-gen                                Regenerate proto by protoc

Testing Lint & Fmt
  test                                      Run tests.
  lint                                      Runs various static analysis against our code.
  fmt                                       Runs fmt code (automatically fix lint errors)

Kubernetes
  cluster                                   Create k3s cluster
  manifests                                 Generates Kubernetes manifests

Release
  prepare-release-candidate                 Create release candidate
  prepare-release                           Create release
  print-version                             Prints the upcoming release number

General
  reference-help                            Generates the reference help documentation.
  help                                      Display this help. Thanks to https://www.thapaliya.com/en/writings/well-documented-makefiles/

Automatic Migration planning script

docker run --rm --name atlas-db-dev -d -p 3306:3306 -e MYSQL_DATABASE=dev -e MYSQL_ROOT_PASSWORD=pass mysql:8