lint in a container for consistency

Author: jshufro

.github/workflows/lint.yml

@@ -13,29 +13,40 @@ permissions:
   # Optional: allow read access to pull request. Use with `only-new-issues` option.
   # pull-requests: read
 jobs:
-  golangci:
-    name: lint
+  detect-modules:
     runs-on: ubuntu-latest
+    outputs:
+      modules: ${{ steps.set-modules.outputs.modules }}
     steps:
-      - uses: actions/setup-go@v4
+      - uses: actions/checkout@v4
+      - uses: actions/setup-go@v5
         with:
           go-version: 1.21.8
-      - uses: actions/checkout@v3
-      - name: golangci-lint
-        uses: golangci/golangci-lint-action@v4
+      - id: set-modules
+        run: echo "modules=$(go list -m -json | jq -s '.' | jq -c '[.[].Dir]')" >> $GITHUB_OUTPUT
+  golangci-lint:
+    needs: detect-modules
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        modules: ${{ fromJSON(needs.detect-modules.outputs.modules) }}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-go@v5
+        with:
+          go-version: 1.21.8
+      - name: golangci-lint ${{ matrix.modules }}
+        uses: golangci/golangci-lint-action@v8
         with:
           # Optional: version of golangci-lint to use in form of v1.2 or v1.2.3 or `latest` to use the latest version
-          version: latest
+          version: v2.1
 
           # Optional: working directory, useful for monorepos
-          # working-directory: somedir
+          working-directory: ${{ matrix.modules }}
 
           # Optional: golangci-lint command line arguments.
           # args: --issues-exit-code=0
 
-          # For now, Smart Node will only enforce goimports linting
-          args: --disable-all --enable goimports addons/... shared/... rocketpool/... rocketpool-cli/...
-
           # Optional: show only new issues if it's a pull request. The default value is `false`.
           # only-new-issues: true
 

.golangci.yml

@@ -0,0 +1,13 @@
+version: "2"
+linters:
+  default: none 
+formatters:
+  enable:
+    - goimports
+run:
+  relative-path-mode: cfg
+  go: '1.21.8'
+output:
+  formats:
+    text:
+      path: stderr

Makefile

@@ -63,15 +63,19 @@ docker:
 	docker manifest create rocketpool/smartnode:${VERSION} --amend rocketpool/smartnode:${VERSION}-amd64 --amend rocketpool/smartnode:${VERSION}-arm64
 	docker manifest create rocketpool/smartnode:latest --amend rocketpool/smartnode:${VERSION}-amd64 --amend rocketpool/smartnode:${VERSION}-arm64
 
-.PHONY: clean
-clean:
-	rm -rf ${BUILD_DIR} 
-
+define lint-template 
+.PHONY: lint-$1
+lint-$1:
+	docker run --rm -v .:/go/smartnode --workdir /go/smartnode/$1 golangci/golangci-lint:v2.1-alpine golangci-lint fmt --diff
+endef
+$(foreach module,$(MODULES),$(eval $(call lint-template,$(module))))
 .PHONY: lint
-lint:
-	@echo $(MODULE_GLOBS)
-	docker run --rm -v .:/go/smartnode --workdir /go/smartnode golangci/golangci-lint:v2.1-alpine golangci-lint fmt --enable goimports $(MODULE_GLOBS)
+lint: $(foreach module,$(MODULES),lint-$(module))
 
 .PHONY: test
 test:
 	go test -test.timeout 20m $(MODULE_GLOBS)
+
+.PHONY: clean
+clean:
+	rm -rf ${BUILD_DIR}

README.md

@@ -28,11 +28,17 @@ See the [Smartnode Installer](https://github.com/rocket-pool/smartnode-install)
 
 A [Makefile](./Makefile) is included for building, testing, and linting.
 
-* `make all` will build rocketpool-cli, rocketpool-daemon, and run the linter.
-* `make rocketpool-daemon` will build the docker containers required to build the daemon, then build the daemon.
-* `make rocketpool-cli` will build the cli for linux and osx.
+* `make` or `make all` will build rocketpool-cli, rocketpool-daemon, and run the linter.
+  * build/rocketpool-cli and build/rocketpool-daemon will be symlinked to the version and architecture specific binaries in build/
+* `make release` will build all architecture specific binaries as well as docker images and manifests
+  * It will tag docker images as latest as well as the version in `shared/version.txt`
+  * It will put cli and native mode binaries in build/\<version\>
+* `make build/rocketpool-cli` builds just the cli
+* `make build/rocketpool-daemon` builds just the daemon
+* `make docker` builds the rocketpool/smartnode container and tags it with latest as well as the version from `shared/version.txt`
+* `make lint` runs the linter.
 * `make test` runs all unit tests.
-* `make clean` deletes any binaries. It does not clear your go caches.
+* `make clean` deletes any binaries. It does not clear your go caches. It does not clean up old docker images.
 
 ## CLI Commands