feat: create config fix tool

.github/labeler.yml

@@ -44,6 +44,8 @@
 "C:Rosetta":
   - contrib/rosetta/**/*
   - tools/rosetta/**/*
+"C:Confix":
+  - tools/confix/**/*
 "C:Keys":
   - client/keys/**/*
 "Type: Build":

.github/workflows/build.yml

@@ -35,15 +35,24 @@ jobs:
             **/go.sum
             **/Makefile
             Makefile
+        ###################
+        #### Build App ####
+        ###################
       - name: Build
         if: env.GIT_DIFF
         run: GOARCH=${{ matrix.go-arch }} LEDGER_ENABLED=false make build
       - name: Build Legacy
         if: env.GIT_DIFF
         run: GOARCH=${{ matrix.go-arch }} LEDGER_ENABLED=false COSMOS_BUILD_OPTIONS=legacy make build
+        ###################
+        ## Build Tooling ##
+        ###################
       - name: Build Cosmovisor
         if: env.GIT_DIFF
         run: GOARCH=${{ matrix.go-arch }} LEDGER_ENABLED=false make cosmovisor
       - name: Build Rosetta
         if: env.GIT_DIFF
         run: GOARCH=${{ matrix.go-arch }} LEDGER_ENABLED=false make rosetta
+      - name: Build Confix
+        if: env.GIT_DIFF
+        run: GOARCH=${{ matrix.go-arch }} LEDGER_ENABLED=false make confix

.github/workflows/release-confix.yml

@@ -0,0 +1,38 @@
+name: Release Confix
+
+on:
+  push:
+    tags:
+      - "tools/confix/v*.*.*"
+permissions:
+  contents: read
+
+jobs:
+  goreleaser:
+    permissions:
+      contents: write # for goreleaser/goreleaser-action to create a GitHub release
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-go@v3
+        with:
+          go-version: 1.19.4
+      # get 'v*.*.*' part from 'confix/v*.*.*' and save to $GITHUB_ENV
+      - name: Set env
+        run: echo "RELEASE_VERSION=${GITHUB_REF#refs/*/confix/}" >> $GITHUB_ENV
+      # remove the possible pre-existing same tag for cosmos-sdk related tags instead of confix tags
+      # Because goreleaser enforces semantic versioning and will error on non compliant tags.(https://goreleaser.com/limitations/semver/)
+      - name: Tag without prefix locally to avoid error in goreleaser
+        run: |-
+          git tag -d ${{ env.RELEASE_VERSION }} || echo "No such a tag exists before"
+          git tag ${{ env.RELEASE_VERSION }} HEAD
+      - name: Run GoReleaser
+        uses: goreleaser/goreleaser-action@v3
+        with:
+          # stick to version v0.179.0(https://github.com/cosmos/cosmos-sdk/issues/11125)
+          version: v0.179.0
+          args: release --rm-dist --skip-validate --release-notes ./RELEASE_NOTES.md
+          workdir: tools/confix
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GORELEASER_CURRENT_TAG: confix/${{ env.RELEASE_VERSION }}

.github/workflows/test.yml

@@ -551,3 +551,33 @@ jobs:
           SONAR_TOKEN: ${{ secrets.SONAR_TOKEN_COSMOVISOR }}
         with:
           projectBaseDir: tools/cosmovisor/
+
+  test-confix:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-go@v3
+        with:
+          go-version: 1.19.4
+          cache: true
+          cache-dependency-path: tools/confix/go.sum
+      - uses: technote-space/get-diff-action@v6.1.2
+        id: git_diff
+        with:
+          PATTERNS: |
+            tools/confix/**/*.go
+            tools/confix/go.mod
+            tools/confix/go.sum
+      - name: tests
+        if: env.GIT_DIFF
+        run: |
+          cd tools/confix
+          go test -mod=readonly -timeout 30m -coverprofile=coverage.out -covermode=atomic -tags='norace ledger test_ledger_mock rocksdb_build' ./...
+      - name: sonarcloud
+        if: env.GIT_DIFF
+        uses: SonarSource/sonarcloud-github-action@master
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN_CONFIX }}
+        with:
+          projectBaseDir: tools/confix/

Makefile

@@ -140,7 +140,10 @@ cosmovisor:
 rosetta:
 	$(MAKE) -C tools/rosetta rosetta
 
-.PHONY: build build-linux-amd64 build-linux-arm64 cosmovisor rosetta
+confix:
+	$(MAKE) -C tools/confix confix
+
+.PHONY: build build-linux-amd64 build-linux-arm64 cosmovisor rosetta confix
 
 
 mocks: $(MOCKS_DIR)

docs/.gitignore

@@ -15,6 +15,7 @@ docs/docs/spec
 docs/docs/architecture
 docs/docs/tooling/01-cosmovisor.md
 docs/docs/tooling/02-depinject.md
+docs/docs/tooling/03-confix.md
 docs/run-node/04-rosetta.md
 
 # Misc

docs/docs/tooling/README.md

@@ -9,3 +9,4 @@ This section provides documentation on various tooling used in development of a
 * [Protocol Buffers](./00-protobuf.md)
 * [Cosmovisor](./01-cosmovisor.md)
 * [Depinject](./02-depinject.md)
+* [Confix](./03-confix.md)

docs/post.sh

@@ -3,6 +3,7 @@
 find docs/modules ! -name '_category_.json' -type f -exec rm -rf {} +
 rm -rf docs/tooling/01-cosmovisor.md
 rm -rf docs/tooling/02-depinject.md
+rm -rf docs/tooling/03-confix.md
 rm -rf docs/run-node/04-rosetta.md
 rm -rf docs/architecture
 rm -rf docs/spec

docs/pre.sh

@@ -17,11 +17,10 @@ cp ../x/auth/tx/README.md ./docs/modules/auth/2-tx.md
 ## Add modules page list
 cat ../x/README.md | sed 's/\.\.\/docs\/building-modules\/README\.md/\/building-modules\/intro\.html/g' > ./docs/modules/README.md
 
-## Add cosmovisor documentation
+## Add tooling documentation
 cp ../tools/cosmovisor/README.md ./docs/tooling/01-cosmovisor.md
-
-## Add depinject documentation
 cp ../depinject/README.md ./docs/tooling/02-depinject.md
+cp ../tools/confix/README.md ./docs/tooling/03-confix.md
 
 ## Add rosetta documentation
 cp ../tools/rosetta/README.md ./docs/run-node/04-rosetta.md

go.work.example

@@ -15,4 +15,5 @@ use (
 	./tests
 	./tools/rosetta
 	./tools/cosmovisor
+	./tools/confix
 )

tools/confix/.gitignore

@@ -0,0 +1 @@
+/confix

tools/confix/.goreleaser.yml

@@ -0,0 +1,34 @@
+project_name: confix
+
+release:
+  disable: false
+  name_template: "{{.Tag}}"
+
+before:
+  hooks:
+    - go mod tidy
+
+builds:
+  - main: ./cmd/confix
+    goos:
+      - linux
+      - windows
+      - darwin
+    goarch:
+      - amd64
+      - arm64
+    env:
+      - CGO_ENABLED=0
+
+archives:
+  - name_template: '{{ replace .Version "confix/" "confix-" }}-{{ .Os }}-{{ .Arch }}'
+    format_overrides:
+      - goos: windows
+        format: zip
+
+checksum:
+  name_template: 'SHA256SUMS-{{ replace .Version "confix/" "confix-" }}.txt'
+  algorithm: sha256
+
+changelog:
+  skip: false

tools/confix/Makefile

@@ -0,0 +1,11 @@
+#!/usr/bin/make -f
+
+all: confix test
+
+confix:
+	go build -mod=readonly ./cmd/confix
+
+test:
+	go test -mod=readonly -race ./...
+
+.PHONY: all confix test

tools/confix/README.md

@@ -0,0 +1,5 @@
+---
+sidebar_position: 1
+---
+
+# Confix

tools/confix/cmd/confix.go

@@ -0,0 +1 @@
+package cmd

tools/confix/cmd/confix/main.go

@@ -0,0 +1 @@
+package main

tools/confix/go.mod

@@ -0,0 +1,3 @@
+module cosmossdk.io/confix
+
+go 1.19

tools/confix/sonar-project.properties

@@ -0,0 +1,15 @@
+sonar.projectKey=cosmos-sdk-tools-confix
+sonar.organization=cosmos
+
+sonar.projectName=Cosmos SDK - Confix
+sonar.project.monorepo.enabled=true
+
+sonar.sources=.
+sonar.exclusions=**/*_test.go
+sonar.tests=.
+sonar.test.inclusions=**/*_test.go
+sonar.go.coverage.reportPaths=coverage.out
+
+sonar.sourceEncoding=UTF-8
+sonar.scm.provider=git
+sonar.pullrequest.github.summary_comment=true