Merge pull request #66 from OpenCHAMI/alexlovelltroy/build-improvements

refactor: build optimizations and better version information

.github/workflows/main.yml

@@ -14,21 +14,36 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - name: Set up Go 1.21
+      - name: Set up latest stable Go
         uses: actions/setup-go@v5
         with:
-          go-version: 1.21
+          go-version: stable
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
+
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-tags: 1
+          fetch-depth: 1
+
+      # Set environment variables required by GoReleaser
+      - name: Set build environment variables
+        run: |
+          echo "GIT_STATE=$(if git diff-index --quiet HEAD --; then echo 'clean'; else echo 'dirty'; fi)" >> $GITHUB_ENV
+          echo "BUILD_HOST=$(hostname)" >> $GITHUB_ENV
+          echo "GO_VERSION=$(go version | awk '{print $3}')" >> $GITHUB_ENV
+          echo "BUILD_USER=$(whoami)" >> $GITHUB_ENV
+          echo "CGO_ENABLED=1" >> $GITHUB_ENV
+
       - name: Docker Login
         uses: docker/login-action@v3
         with:
           registry: ghcr.io
           username: ${{ github.actor }}
           password: ${{ secrets.GITHUB_TOKEN }}
-      - name: Checkout
-        uses: actions/checkout@v4
-        with:
-          fetch-tags: 1
-          fetch-depth: 0
+
       - name: Release with goreleaser
         uses: goreleaser/goreleaser-action@v6
         env:

.github/workflows/prbuild.yml

@@ -0,0 +1,44 @@
+name: Build PR with goreleaser
+
+on:
+    pull_request:
+        branches:
+            - main
+        types: [opened, synchronize, reopened, edited]
+    workflow_dispatch:
+
+jobs:
+  prbuild:
+    runs-on: ubuntu-latest
+    steps:
+
+      - name: Set up latest stable Go
+        uses: actions/setup-go@v5
+        with:
+          go-version: stable
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
+
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-tags: 1
+          fetch-depth: 1
+
+      # Set environment variables required by GoReleaser
+      - name: Set build environment variables
+        run: |
+          echo "GIT_STATE=$(if git diff-index --quiet HEAD --; then echo 'clean'; else echo 'dirty'; fi)" >> $GITHUB_ENV
+          echo "BUILD_HOST=$(hostname)" >> $GITHUB_ENV
+          echo "GO_VERSION=$(go version | awk '{print $3}')" >> $GITHUB_ENV
+          echo "BUILD_USER=$(whoami)" >> $GITHUB_ENV
+          echo "CGO_ENABLED=1" >> $GITHUB_ENV
+
+      - name: Build with goreleaser
+        uses: goreleaser/goreleaser-action@v6
+
+        with:
+          version: '~> v2'
+          args: release --snapshot
+        id: goreleaser

.gitignore

@@ -6,3 +6,4 @@ emulator/rf-emulator
 **.part
 dist/*
 **coverage.out**
+magellan.1

.goreleaser.yaml

@@ -7,12 +7,36 @@ before:
     - go-md2man -in README.md -out magellan.1
 
 builds:
-  - env:
-      - CGO_ENABLED=1
+  - binary: magellan
+    main: ./main.go
+    # export GIT_STATE=$(if git diff-index --quiet HEAD --; then echo 'clean'; else echo 'dirty'; fi)
+    # export BUILD_HOST=$(hostname)
+    # export GO_VERSION=$(go version | awk '{print $3}')
+    # export BUILD_USER=$(whoami)
+    ldflags:
+      - "-X github.com/OpenCHAMI/magellan/internal/version.GitCommit={{ .Commit }} \
+        -X github.com/OpenCHAMI/magellan/internal/version.BuildTime={{ .Timestamp }} \
+        -X github.com/OpenCHAMI/magellan/internal/version.Version={{ .Version }} \
+        -X github.com/OpenCHAMI/magellan/internal/version.GitBranch={{ .Branch }} \
+        -X github.com/OpenCHAMI/magellan/internal/version.GitTag={{ .Tag }} \
+        -X github.com/OpenCHAMI/magellan/internal/version.GitState={{ .Env.GIT_STATE }} \
+        -X github.com/OpenCHAMI/magellan/internal/version.BuildHost={{ .Env.BUILD_HOST }} \
+        -X github.com/OpenCHAMI/magellan/internal/version.GoVersion={{ .Env.GO_VERSION }} \
+        -X github.com/OpenCHAMI/magellan/internal/version.BuildUser={{ .Env.BUILD_USER }} "
+    tags:
+      - version
     goos:
       - linux
+      - darwin
+      - windows
     goarch:
       - amd64
+      - arm64
+    goamd64:
+      - v3
+    env:
+      - CGO_ENABLED=0
+
 archives:
   - format: tar.gz
     # this name template makes the OS and Arch compatible with the results of uname.
@@ -27,26 +51,89 @@ archives:
       - LICENSE
       - CHANGELOG.md
       - README.md
-      - bin/magellan.sh
       - magellan.1
+
+nfpms:
+        - id: magellan
+          formats: 
+          - deb
+          - rpm
+          - apk
+          - archlinux
+          maintainer: "David J. Allen <[email protected]>"
+          description: "Magellan is a discovery tool for BMCs."
+          homepage: "https://www.openchami.org"
+          license: MIT
+          section: utils
+          priority: optional
+          contents:
+            - src: dist/magellan_{{ .Os }}_{{ if eq .Arch "amd64" }}{{ .Arch }}_{{ .Amd64 }}{{ else }}{{ .Arch }}{{ end }}/magellan
+              dst: /usr/local/bin/magellan
+            - src: magellan.1
+              dst: /usr/share/man/man1/
+
+
 dockers:
-  - 
-    image_templates:
-      - ghcr.io/openchami/{{.ProjectName}}:latest
-      - ghcr.io/openchami/{{.ProjectName}}:{{ .Tag }}
-      - ghcr.io/openchami/{{.ProjectName}}:v{{ .Major }}
-      - ghcr.io/openchami/{{.ProjectName}}:v{{ .Major }}.{{ .Minor }}
+  - image_templates:
+      - &amd64_linux_image ghcr.io/openchami/{{.ProjectName}}:{{ .Tag }}-amd64
+      - ghcr.io/openchami/{{.ProjectName}}:{{ .Major }}-amd64
+      - ghcr.io/openchami/{{.ProjectName}}:{{ .Major }}.{{ .Minor }}-amd64
+    use: buildx
     build_flag_templates:
       - "--pull"
+      - "--platform=linux/amd64"
       - "--label=org.opencontainers.image.created={{.Date}}"
       - "--label=org.opencontainers.image.title={{.ProjectName}}"
       - "--label=org.opencontainers.image.revision={{.FullCommit}}"
       - "--label=org.opencontainers.image.version={{.Version}}"
+    goarch: amd64
+    goamd64: v3
     extra_files:
       - LICENSE
       - CHANGELOG.md
       - README.md
-      - bin/magellan.sh
+  - image_templates:
+      - &arm64v8_linux_image ghcr.io/openchami/{{.ProjectName}}:{{ .Tag }}-arm64
+      - ghcr.io/openchami/{{.ProjectName}}:{{ .Major }}-arm64
+      - ghcr.io/openchami/{{.ProjectName}}:{{ .Major }}.{{ .Minor }}-arm64
+    use: buildx
+    build_flag_templates:
+      - "--pull"
+      - "--platform=linux/arm64"
+      - "--label=org.opencontainers.image.created={{.Date}}"
+      - "--label=org.opencontainers.image.title={{.ProjectName}}"
+      - "--label=org.opencontainers.image.revision={{.FullCommit}}"
+      - "--label=org.opencontainers.image.version={{.Version}}"
+    extra_files:
+      - LICENSE
+      - CHANGELOG.md
+      - README.md
+    goarch: arm64
+
+docker_manifests:
+  - name_template: "ghcr.io/openchami/{{.ProjectName}}:latest"
+    image_templates:
+      - *amd64_linux_image
+      - *arm64v8_linux_image
+
+  - name_template: "ghcr.io/openchami/{{.ProjectName}}:{{ .Tag }}"
+    image_templates:
+      - *amd64_linux_image
+      - *arm64v8_linux_image
+
+  - name_template: "ghcr.io/openchami/{{.ProjectName}}:{{ .Major }}"
+    image_templates:
+      - *amd64_linux_image
+      - *arm64v8_linux_image
+
+  - name_template: "ghcr.io/openchami/{{.ProjectName}}:{{ .Major }}.{{ .Minor }}"
+    image_templates:
+      - *amd64_linux_image
+      - *arm64v8_linux_image
+
+
+
+
 checksum:
   name_template: 'checksums.txt'
 snapshot:
@@ -57,8 +144,3 @@ changelog:
     exclude:
       - '^docs:'
       - '^test:'
-release:
-  github:
-  name_template: "{{.Version}}"
-  prerelease: auto
-  mode: append

Dockerfile

@@ -1,13 +1,17 @@
-FROM cgr.dev/chainguard/wolfi-base
+FROM chainguard/wolfi-base:latest
 
-RUN apk add --no-cache tini bash
+# Include curl in the final image for manual checks of the Redfish urls
+RUN set -ex \
+    && apk update \
+    && apk add --no-cache curl tini \
+    && rm -rf /var/cache/apk/*  \
+    && rm -rf /tmp/*
 
 # nobody 65534:65534
 USER 65534:65534
 
 
 COPY  magellan  /magellan
-COPY  /bin/magellan.sh /magellan.sh
 
 
 CMD [ "/magellan" ]