tools: Organize our config files and tooling.

sourcenetwork · Apr 14, 2022 · 0750785 · 0750785
1 parent 54b400e
commit 0750785
Show file tree

Hide file tree

Showing 8 changed files with 37 additions and 27 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -5,22 +5,22 @@ version: 2.1
 # Define a job to be invoked later in a workflow.
 # See: https://circleci.com/docs/2.0/configuration-reference/#jobs
 jobs:
+
+  # Job builds and runs all the test.
   build:
     working_directory: ~/repo
-    # Specify the execution environment. You can specify an image from Dockerhub or use one of our Convenience Images from CircleCI's Developer Hub.
-    # See: https://circleci.com/docs/2.0/configuration-reference/#docker-machine-macos-windows-executor
     docker:
-      - image: circleci/golang:1.17.5
+      # https://circleci.com/developer/images/image/cimg/go
+      - image: cimg/go:1.17
     # Add steps to the job
-    # See: https://circleci.com/docs/2.0/configuration-reference/#steps
     steps:
       - checkout
       - restore_cache:
           keys:
             - go-mod-v4-{{ checksum "go.sum" }}
       - run:
-          name: Install Dependencies
-          command: make deps
+          name: Install go modules into the module cache.
+          command: make deps:modules
       - save_cache:
           key: go-mod-v4-{{ checksum "go.sum" }}
           paths:
@@ -36,22 +36,22 @@ jobs:
             DEFRA_MAP: true
       - store_test_results:
           path: /tmp/test-reports
+
+  # Job detects if we have a change.
   change_detection:
     working_directory: ~/repo
-    # Specify the execution environment. You can specify an image from Dockerhub or use one of our Convenience Images from CircleCI's Developer Hub.
-    # See: https://circleci.com/docs/2.0/configuration-reference/#docker-machine-macos-windows-executor
     docker:
-      - image: circleci/golang:1.17.5
+      # https://circleci.com/developer/images/image/cimg/go
+      - image: cimg/go:1.17
     # Add steps to the job
-    # See: https://circleci.com/docs/2.0/configuration-reference/#steps
     steps:
       - checkout
       - restore_cache:
           keys:
             - go-mod-v4-{{ checksum "go.sum" }}
       - run:
-          name: Install Dependencies
-          command: make deps
+          name: Install go modules into the module cache.
+          command: make deps:modules
       - save_cache:
           key: go-mod-v4-{{ checksum "go.sum" }}
           paths:
@@ -67,7 +67,6 @@ jobs:
           path: /tmp/test-reports
 
 # Invoke jobs via workflows
-# See: https://circleci.com/docs/2.0/configuration-reference/#workflows
 workflows:
   build-test: # This is the name of the workflow, feel free to change it to better match your workflow.
     # Inside the workflow, you define the jobs you want to run.

diff --git a/codecov.yml → .github/codecov.yml b/codecov.yml → .github/codecov.yml
diff --git a/.github/workflows/lint-then-benchmark.yml b/.github/workflows/lint-then-benchmark.yml
@@ -66,7 +66,7 @@ jobs:
           #  exist or not doesn't matter). But the good think is that the annotations
           #  will still show up. I think this can be useful if we don't want the pipeline
           #  to stop just because we had some linter errors. 
-          args: --issues-exit-code=1 --config .golangci.sourceinc.yaml
+          args: --issues-exit-code=1 --config tools/configs/golangci.yaml
 
           # Optional: we can set the below to `true` if we only want to see newly
           #  introduced linter errors, however I found that in practive that option is a
@@ -251,7 +251,7 @@ jobs:
           make deps:bench &&
           cp bench-artifact-${{ steps.last_successful_upload_on_develop.outputs.commit_hash }}.txt develop.txt &&
           ${GOPATH}/bin/benchstat -html -alpha 1.1 develop.txt current.txt | sed -n "/<body>/,/<\/body>/p" > comparison.html &&
-          ./tools/pretty-benchstat-html.sh comparison.html > pretty-comparison.md
+          ./tools/scripts/pretty-benchstat-html.sh comparison.html > pretty-comparison.md
 
       - name: Comment Benchmark Results on PR
         if: |

diff --git a/Makefile b/Makefile
@@ -28,22 +28,29 @@ dump: build
 deps\:lint:
 	curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b ${GOPATH}/bin latest
 
-.PHONY: deps\:go-acc
-deps\:go-acc:
+.PHONY: deps\:coverage
+deps\:coverage:
 	go install github.com/ory/go-acc@latest
 
-.PHONY: deps\:go-lines
-deps\:go-lines:
-	go install github.com/segmentio/golines@latest
-
 .PHONY: deps\:bench
 deps\:bench:
 	go install golang.org/x/perf/cmd/benchstat@latest
 
-.PHONY: deps
-deps: deps\:lint deps\:go-acc deps\:bench
+.PHONY: deps\:golines
+deps\:golines:
+	go install github.com/segmentio/golines@latest
+
+.PHONY: deps\:chglog
+deps\:chglog:
+	go install github.com/git-chglog/git-chglog/cmd/git-chglog@latest
+
+.PHONY: deps\:modules
+deps\:modules:
 	go mod download
 
+.PHONY: deps
+deps: deps\:lint deps\:coverage deps\:bench deps\:golines deps\:chglog deps\:modules
+
 .PHONY: tidy
 tidy:
 	go mod tidy
@@ -74,7 +81,7 @@ test\:bench-short:
 
 # This also takes integration tests into account.
 .PHONY: test\:coverage-full
-test\:coverage-full: deps\:go-acc
+test\:coverage-full: deps\:coverage
 	go-acc ./... --output=coverage-full.txt --covermode=atomic
 	go tool cover -func coverage-full.txt | grep total | awk '{print $$3}'
 
@@ -90,16 +97,20 @@ test\:changes:
 
 .PHONY: validate\:codecov
 validate\:codecov:
-	curl --data-binary @codecov.yml https://codecov.io/validate
+	curl --data-binary @.github/codecov.yml https://codecov.io/validate
 
 .PHONY: lint
 lint:
-	golangci-lint run --config .golangci.sourceinc.yaml
+	golangci-lint run --config tools/configs/golangci.yaml
 
 .PHONY: lint\:todo
 lint\:todo:
 	rg "nolint" -g '!{Makefile}'
 
 .PHONY: lint\:list
 lint\:list:
-	golangci-lint linters --config .golangci.sourceinc.yaml
+	golangci-lint linters --config tools/configs/golangci.yaml
+
+.PHONY: chglog
+chglog:
+	git-chglog -c "tools/configs/chglog/config.yml" --next-tag v0.x.0 -o CHANGELOG.md
diff --git a/.chglog/CHANGELOG.tpl.md → tools/configs/chglog/CHANGELOG.tpl.md b/.chglog/CHANGELOG.tpl.md → tools/configs/chglog/CHANGELOG.tpl.md
diff --git a/.chglog/config.yml → tools/configs/chglog/config.yml b/.chglog/config.yml → tools/configs/chglog/config.yml
diff --git a/.golangci.sourceinc.yaml → tools/configs/golangci.yaml b/.golangci.sourceinc.yaml → tools/configs/golangci.yaml
diff --git a/tools/pretty-benchstat-html.sh → tools/scripts/pretty-benchstat-html.sh b/tools/pretty-benchstat-html.sh → tools/scripts/pretty-benchstat-html.sh