feat: initial structure (#1)

.github/dependabot.yml

@@ -0,0 +1,19 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "docker"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+  - package-ecosystem: "gomod"
+    directory: "/"
+    schedule:
+      interval: "weekly"

.github/workflows/ci-docker.yml

@@ -0,0 +1,31 @@
+name: Docker CI
+
+on:
+  pull_request:
+    branches: ['main']
+    paths: ['Dockerfile','cmd/**','docs/**','internal/**','go.*','.github/workflows/ci-docker.yml']
+
+env:
+  GHCR_IMAGE_NAME: ghcr.io/blinklabs-io/node
+
+jobs:
+  docker:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: qemu
+        uses: docker/setup-qemu-action@v3
+      - uses: docker/setup-buildx-action@v3
+      - id: meta
+        uses: docker/metadata-action@v5
+        with:
+          images: ${{ env.GHCR_IMAGE_NAME }}
+      - name: build
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          push: false
+          ### TODO: test multiple platforms
+          # platforms: linux/amd64,linux/arm64
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}

.github/workflows/conventional-commits.yml

@@ -0,0 +1,16 @@
+# The below is pulled from upstream and slightly modified
+# https://github.com/webiny/action-conventional-commits/blob/master/README.md#usage
+
+name: Conventional Commits
+
+on:
+  pull_request:
+
+jobs:
+  build:
+    name: Conventional Commits
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: webiny/action-conventional-commits@v1.3.0

.github/workflows/go-test.yml

@@ -0,0 +1,25 @@
+name: go-test
+
+on:
+  push:
+    tags:
+      - v*
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  go-test:
+    name: go-test
+    strategy:
+      matrix:
+        go-version: [1.21.x, 1.22.x]
+        platform: [ubuntu-latest, macos-latest]
+    runs-on: ${{ matrix.platform }}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-go@v5
+        with:
+          go-version: ${{ matrix.go-version }}
+      - name: go-test
+        run: go test ./...

.github/workflows/golangci-lint.yml

@@ -0,0 +1,33 @@
+# This file was copied from the following URL and modified:
+# https://github.com/golangci/golangci-lint-action/blob/master/README.md#how-to-use
+
+name: golangci-lint
+on:
+  push:
+    tags:
+      - v*
+    branches:
+      - main
+  pull_request:
+
+permissions:
+  contents: read
+  pull-requests: read
+
+jobs:
+  golangci:
+    name: lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-go@v5
+        with:
+          go-version: 1.21.x
+          cache: false
+      - name: golangci-lint
+        uses: golangci/golangci-lint-action@v4
+        with:
+          version: v1.54 # current version at time of commit
+          args: --timeout=10m
+          # Only show new issues in a PR but show all issues for pushes
+          only-new-issues: ${{ github.event_name == 'pull_request' && 'true' || 'false' }}

.github/workflows/publish.yml

@@ -0,0 +1,141 @@
+name: publish
+
+on:
+  push:
+    branches: ['main']
+    tags:
+      - 'v*.*.*'
+
+concurrency: ${{ github.ref }}
+
+jobs:
+  create-draft-release:
+    runs-on: ubuntu-latest
+    outputs:
+      RELEASE_ID: ${{ steps.create-release.outputs.result }}
+    steps:
+      - run: "echo \"RELEASE_TAG=${GITHUB_REF#refs/tags/}\" >> $GITHUB_ENV"
+      - uses: actions/github-script@v7
+        id: create-release
+        if: startsWith(github.ref, 'refs/tags/')
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          result-encoding: string
+          script: |
+            try {
+              const response = await github.rest.repos.createRelease({
+                draft: true,
+                generate_release_notes: true,
+                name: process.env.RELEASE_TAG,
+                owner: context.repo.owner,
+                prerelease: false,
+                repo: context.repo.repo,
+                tag_name: process.env.RELEASE_TAG,
+              });
+
+              return response.data.id;
+            } catch (error) {
+              core.setFailed(error.message);
+            }
+
+  build-binaries:
+    strategy:
+      matrix:
+        os: [linux, darwin]
+        arch: [amd64, arm64]
+    runs-on: ubuntu-latest
+    needs: [create-draft-release]
+    steps:
+      - run: "echo \"RELEASE_TAG=${GITHUB_REF#refs/tags/}\" >> $GITHUB_ENV"
+      - uses: actions/checkout@v4
+      - uses: actions/setup-go@v5
+        with:
+          go-version: 1.21.x
+      - name: Build binary
+        run: GOOS=${{ matrix.os }} GOARCH=${{ matrix.arch }} make build
+      - name: Upload release asset
+        if: startsWith(github.ref, 'refs/tags/')
+        run: |
+          _filename=node-${{ env.RELEASE_TAG }}-${{ matrix.os }}-${{ matrix.arch }}
+          mv node ${_filename}
+          curl \
+            -H "Authorization: token ${{ secrets.GITHUB_TOKEN }}" \
+            -H "Content-Type: application/octet-stream" \
+            --data-binary @${_filename} \
+            https://uploads.github.com/repos/${{ github.repository_owner }}/node/releases/${{ needs.create-draft-release.outputs.RELEASE_ID }}/assets?name=${_filename}
+
+  build-images:
+    runs-on: ubuntu-latest
+    needs: [create-draft-release]
+    steps:
+      - run: "echo \"RELEASE_TAG=${GITHUB_REF#refs/tags/}\" >> $GITHUB_ENV"
+      - uses: actions/checkout@v4
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+      - name: Login to Docker Hub
+        uses: docker/login-action@v3
+        with:
+          username: blinklabs
+          password: ${{ secrets.DOCKER_PASSWORD }} # uses token
+      - name: Login to GHCR
+        uses: docker/login-action@v3
+        with:
+          username: ${{ github.repository_owner }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+          registry: ghcr.io
+      - id: meta
+        uses: docker/metadata-action@v5
+        with:
+          images: |
+            blinklabs/node
+            ghcr.io/${{ github.repository }}
+          tags: |
+            # Only version, no revision
+            type=match,pattern=v(.*)-(.*),group=1
+            # branch
+            type=ref,event=branch
+            # semver
+            type=semver,pattern={{version}}
+      - name: Build images
+        uses: docker/build-push-action@v5
+        with:
+          outputs: "type=registry,push=true"
+          platforms: linux/amd64,linux/arm64
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+      # Update Docker Hub from README
+      - name: Docker Hub Description
+        uses: peter-evans/dockerhub-description@v4
+        with:
+          username: blinklabs
+          password: ${{ secrets.DOCKER_PASSWORD }}
+          repository: blinklabs/node
+          readme-filepath: ./README.md
+          short-description: "Cardano Blockchain Node"
+
+  finalize-release:
+    runs-on: ubuntu-latest
+    needs: [create-draft-release, build-binaries, build-images]
+    steps:
+      - uses: actions/github-script@v7
+        if: startsWith(github.ref, 'refs/tags/')
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          script: |
+            try {
+              await github.rest.repos.updateRelease({
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                release_id: ${{ needs.create-draft-release.outputs.RELEASE_ID }},
+                draft: false,
+              });
+            } catch (error) {
+              core.setFailed(error.message);
+            }
+
+      # This updates the documentation on pkg.go.dev and the latest version available via the Go module proxy
+      - name: Pull new module version
+        if: startsWith(github.ref, 'refs/tags/')
+        uses: andrewslotin/go-proxy-pull-action@v1.1.0

.gitignore

@@ -19,3 +19,6 @@
 
 # Go workspace file
 go.work
+
+# Program binary
+/node

CODEOWNERS

@@ -0,0 +1,3 @@
+# Blink Labs
+#
+* @agaffney @verbotenj @wolf31o2

Dockerfile

@@ -0,0 +1,9 @@
+FROM ghcr.io/blinklabs-io/go:1.21.9-1 AS build
+
+WORKDIR /code
+COPY . .
+RUN make build
+
+FROM cgr.dev/chainguard/glibc-dynamic AS node
+COPY --from=build /code/node /bin/
+ENTRYPOINT ["node"]

Makefile

@@ -0,0 +1,50 @@
+# Determine root directory
+ROOT_DIR=$(shell dirname $(realpath $(firstword $(MAKEFILE_LIST))))
+
+# Gather all .go files for use in dependencies below
+GO_FILES=$(shell find $(ROOT_DIR) -name '*.go')
+
+# Gather list of expected binaries
+BINARIES=$(shell cd $(ROOT_DIR)/cmd && ls -1 | grep -v ^common)
+
+# Extract Go module name from go.mod
+GOMODULE=$(shell grep ^module $(ROOT_DIR)/go.mod | awk '{ print $$2 }')
+
+# Set version strings based on git tag and current ref
+GO_LDFLAGS=-ldflags "-s -w -X '$(GOMODULE)/internal/version.Version=$(shell git describe --tags --exact-match 2>/dev/null)' -X '$(GOMODULE)/internal/version.CommitHash=$(shell git rev-parse --short HEAD)'"
+
+.PHONY: build mod-tidy clean format golines test
+
+# Alias for building program binary
+build: $(BINARIES)
+
+# Builds and installs binary in ~/.local/bin
+install: build
+	mv $(BINARIES) $(HOME)/.local/bin
+
+uninstall:
+	rm -f $(HOME)/.local/bin/$(BINARIES)
+mod-tidy:
+	# Needed to fetch new dependencies and add them to go.mod
+	go mod tidy
+
+clean:
+	rm -f $(BINARIES)
+
+format:
+	go fmt ./...
+
+golines:
+	golines -w --ignore-generated --chain-split-dots --max-len=80 --reformat-tags .
+
+test: mod-tidy
+	go test -v -race ./...
+
+# Build our program binaries
+# Depends on GO_FILES to determine when rebuild is needed
+$(BINARIES): mod-tidy $(GO_FILES)
+	CGO_ENABLED=0 \
+	go build \
+		$(GO_LDFLAGS) \
+		-o $(@) \
+		./cmd/$(@)