Restructuring repository based on feedback (#17)

* Restructuring repository based on feedback from Matt Bishop

* Apply suggestions from code review

Co-authored-by: Vince Grassia <[email protected]>

---------

Co-authored-by: Vince Grassia <[email protected]>

Author: jhbeskow

src/sm-operator/.devcontainer/common/devcontainer.json renamed to .devcontainer/devcontainer.json

@@ -2,7 +2,7 @@
   "name": "BW k8s Operator",
   "image": "mcr.microsoft.com/devcontainers/go:1.21",
   "runArgs": ["--network=host"], // needed for kind
-  "postCreateCommand": "sudo .devcontainer/common/postCreateCommand.sh",
+  "postCreateCommand": "sudo .devcontainer/postCreateCommand.sh",
   "customizations": {
     "vscode": {
       "extensions": [

src/sm-operator/.devcontainer/common/kind-config.yaml renamed to .devcontainer/kind-config.yaml

@@ -1,13 +1,11 @@
 #!/usr/bin/env bash
 apt-get update
 apt-get install -y kubernetes-client musl-tools # kubectl
-kind delete cluster --name sm-operator && kind create cluster --name sm-operator --config .devcontainer/common/kind-config.yaml
-# kind export kubeconfig
+kind delete cluster --name sm-operator && kind create cluster --name sm-operator --config .devcontainer/kind-config.yaml
 
 PATH="$PATH:/usr/local/go/bin" make setup
 PATH="$PATH:/usr/local/go/bin" make install
 
-# shellcheck disable=SC2016
 echo '
 devcontainer setup complete!
 

src/sm-operator/.devcontainer/common/postCreateCommand.sh renamed to .devcontainer/postCreateCommand.sh

@@ -36,7 +36,6 @@ jobs:
         id: test
         run: |
           sudo apt update && sudo apt install musl-tools -y
-          cd src/sm-operator
           make setup
           make test
           go tool cover -html=cover.out -o=cover.html
@@ -45,7 +44,7 @@ jobs:
         uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32 # v3.1.3
         with:
           name: cover.html
-          path: src/sm-operator/cover.html
+          path: cover.html
           if-no-files-found: error
 
       - name: Generate Docker image tag
@@ -66,8 +65,7 @@ jobs:
       - name: Build Docker image
         uses: docker/build-push-action@2cdde995de11925a030ce8070c3d77a52ffcf1c0 # v5.3.0
         with:
-          context: src/sm-operator
-          file: src/sm-operator/Dockerfile
+          file: Dockerfile
           platforms: linux/amd64,linux/arm64
           push: true
           tags: ${{ steps.image-name.outputs.name }}
@@ -80,7 +78,6 @@ jobs:
         env:
           IMAGE: ${{ steps.image-name.outputs.name }}
         run: |
-          cd src/sm-operator
           make deploy IMG=$IMAGE
 
           #Setup image pull secret (Until repo is made public)
@@ -114,6 +111,5 @@ jobs:
 
       - name: Clean-up
         run: |
-          cd src/sm-operator
           make undeploy
           kind delete cluster

src/sm-operator/.dockerignore renamed to .dockerignore

@@ -35,7 +35,6 @@ jobs:
         id: test
         run: |
           sudo apt update && sudo apt install musl-tools -y
-          cd src/sm-operator
           make setup
           make test
           go tool cover -html=cover.out -o=cover.html
@@ -45,7 +44,7 @@ jobs:
         uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32 # v3.1.3
         with:
           name: cover.html
-          path: src/sm-operator/cover.html
+          path: cover.html
           if-no-files-found: error
 
       - name: Generate Docker image tag
@@ -66,8 +65,7 @@ jobs:
       - name: Build Docker image
         uses: docker/build-push-action@2cdde995de11925a030ce8070c3d77a52ffcf1c0 # v5.3.0
         with:
-          context: src/sm-operator
-          file: src/sm-operator/Dockerfile
+          file: Dockerfile
           platforms: linux/amd64,linux/arm64
           push: true
           tags: ${{ steps.image-name.outputs.name }}
@@ -80,7 +78,6 @@ jobs:
         env:
           IMAGE: ${{ steps.image-name.outputs.name }}
         run: |
-          cd src/sm-operator
           make deploy IMG=$IMAGE
 
           #Setup image pull secret (Until repo is made public)
@@ -114,6 +111,5 @@ jobs:
 
       - name: Clean-up
         run: |
-          cd src/sm-operator
           make undeploy
           kind delete cluster

src/sm-operator/.env.example renamed to .env.example

@@ -45,7 +45,7 @@ jobs:
 
       - name: Bump Version
         run: |
-          sed -i -E '/^VERSION\s+\?=\s+[^\s]+/!b;cVERSION ?= ${{ github.event.inputs.version_number }}' src/sm-operator/Makefile
+          sed -i -E '/^VERSION\s+\?=\s+[^\s]+/!b;cVERSION ?= ${{ github.event.inputs.version_number }}' Makefile
 
       - name: Setup git
         run: |

.github/workflows/build.yml

@@ -38,7 +38,7 @@ jobs:
       - name: Get Version
         id: version
         run: |
-          VERSION=$(sed -nE 's/^VERSION\s+\?=\s+([^\s]+)/\1/p' src/sm-operator/Makefile)
+          VERSION=$(sed -nE 's/^VERSION\s+\?=\s+([^\s]+)/\1/p' Makefile)
           echo "version=$VERSION" >> $GITHUB_OUTPUT
 
       - name: Get branch name

.github/workflows/build_ghcr.yml

@@ -23,9 +23,33 @@ Thumbs.db
 node_modules
 npm-debug.log
 
-src/sm-operator/bin/*
-src/sm-operator/sm-operator.tar
-src/sm-operator/bw-sdk/internal/cinterface/lib/*
-src/sm-operator/cmd/__debug_bin*
+# Binaries for programs and plugins
+*.exe
+*.exe~
+*.dll
+*.so
+*.dylib
+bin/*
+Dockerfile.cross
+
+# Test binary, build with `go test -c`
+*.test
+
+# Output of the go coverage tool, specifically when used with LiteIDE
+*.out
+
+# Kubernetes Generated files - skip generated files, except for vendored files
+
+!vendor/**/zz_generated.*
+
+# editor and IDE paraphernalia
+.idea
+*.swp
+*.swo
+*~
+
+sm-operator.tar
+bw-sdk/internal/cinterface/lib/*
+**/__debug_bin*
 **/temp.zip
 **/.env