|
| 1 | +version: "3" |
| 2 | + |
| 3 | +env: |
| 4 | + INSTALL_DIR: |
| 5 | + sh: "echo ${INSTALL_DIR:-/usr/local/bin}" |
| 6 | + IMAGE_TAG: "gatecheck:latest" |
| 7 | + |
| 8 | +tasks: |
| 9 | + build: |
| 10 | + desc: "Build the gatecheck binary" |
| 11 | + vars: |
| 12 | + BUILD_DATE: '{{dateInZone "2006-01-02T15:04:05Z" now "UTC"}}' |
| 13 | + CLI_VERSION: |
| 14 | + sh: git describe --tags || git rev-parse --short HEAD || "v0.0.0-unknown" |
| 15 | + GIT_COMMIT: |
| 16 | + sh: git rev-parse HEAD |
| 17 | + GIT_DESCRIPTION: |
| 18 | + sh: git log -1 --pretty=%B | sed "s/'//g" |
| 19 | + cmds: |
| 20 | + - mkdir -p bin |
| 21 | + - go build -ldflags="-X 'main.cliVersion={{.CLI_VERSION}}' -X 'main.gitCommit={{.GIT_COMMIT}}' -X 'main.buildDate={{.BUILD_DATE}}' -X 'main.gitDescription={{.GIT_DESCRIPTION}}'" -o ./bin ./cmd/gatecheck |
| 22 | + sources: |
| 23 | + - cmd/**/* |
| 24 | + - pkg/**/* |
| 25 | + - go.* |
| 26 | + generates: |
| 27 | + - bin/gatecheck |
| 28 | + |
| 29 | + install: |
| 30 | + desc: "Install the gatecheck binary" |
| 31 | + prompt: 'Install gatecheck binary to {{joinPath .INSTALL_DIR "gatecheck"}} ...Continue?' |
| 32 | + deps: |
| 33 | + - build |
| 34 | + cmds: |
| 35 | + - cp ./bin/gatecheck {{joinPath .INSTALL_DIR "gatecheck"}} |
| 36 | + sources: |
| 37 | + - ./bin/gatecheck |
| 38 | + generates: |
| 39 | + - '{{joinPath .INSTALL_DIR "gatecheck"}}' |
| 40 | + |
| 41 | + uninstall: |
| 42 | + desc: "Uninstall the gatecheck binary" |
| 43 | + prompt: 'Will remove binary {{joinPath .INSTALL_DIR "gatecheck"}}' |
| 44 | + cmds: |
| 45 | + - rm '{{joinPath .INSTALL_DIR "gatecheck"}}' |
| 46 | + |
| 47 | + test: |
| 48 | + desc: "Run unit tests with coverage" |
| 49 | + cmds: |
| 50 | + - go test -cover ./... |
| 51 | + |
| 52 | + lint: |
| 53 | + desc: "Run golangci-lint in view-only mode" |
| 54 | + cmds: |
| 55 | + - golangci-lint run |
| 56 | + |
| 57 | + fix: |
| 58 | + desc: "Fix linting errors and format code" |
| 59 | + cmds: |
| 60 | + - golangci-lint run --fix |
| 61 | + |
| 62 | + format: |
| 63 | + desc: "Check code formatting" |
| 64 | + cmds: |
| 65 | + - | |
| 66 | + if [ -n "$(gofmt -l .)" ]; then |
| 67 | + gofmt -d . |
| 68 | + exit 1 |
| 69 | + fi |
| 70 | +
|
| 71 | + coverage: |
| 72 | + desc: "Generate test coverage" |
| 73 | + cmds: |
| 74 | + - go test -coverprofile=coverage.out ./... |
| 75 | + |
| 76 | + open-coverage: |
| 77 | + desc: "Open coverage report in browser" |
| 78 | + deps: [coverage] |
| 79 | + cmds: |
| 80 | + - go tool cover -html=coverage.out |
| 81 | + |
| 82 | + dependencies: |
| 83 | + desc: "Download dependencies" |
| 84 | + cmds: |
| 85 | + - go mod download |
| 86 | + |
| 87 | + upgrade: |
| 88 | + desc: "Upgrade package dependencies" |
| 89 | + preconditions: |
| 90 | + - sh: git diff --quiet && git diff --cached --quiet |
| 91 | + msg: "Repository is dirty, commit changes before upgrading." |
| 92 | + cmds: |
| 93 | + - go get -u ./... |
| 94 | + - go mod tidy |
| 95 | + |
| 96 | + serve-docs: |
| 97 | + desc: "Serve documentation locally" |
| 98 | + cmds: |
| 99 | + - mdbook serve |
| 100 | + |
| 101 | + all: |
| 102 | + desc: "Run format, test, and build" |
| 103 | + deps: [format, test, build] |
| 104 | + |
| 105 | + release-snapshot: |
| 106 | + desc: "Create a snapshot release" |
| 107 | + cmds: |
| 108 | + - goreleaser release --snapshot --rm-dist |
| 109 | + |
| 110 | + release: |
| 111 | + desc: "Create a release" |
| 112 | + cmds: |
| 113 | + - goreleaser release --rm-dist |
| 114 | + |
| 115 | + clean: |
| 116 | + desc: "Clean up build artifacts" |
| 117 | + cmds: |
| 118 | + - rm -rf ./bin coverage.out |
0 commit comments