refactor: project layout improvements

M0Rf30 · Oct 21, 2023 · db411fa · db411fa
1 parent d6572e3
commit db411fa
Show file tree

Hide file tree

Showing 52 changed files with 244 additions and 117 deletions.
diff --git a/.github/workflows/docker-image.yml b/.github/workflows/docker-image.yml
@@ -39,7 +39,7 @@ jobs:
           labels: ${{ steps.meta.outputs.labels }}
           tags: |
             m0rf30/yap-alpine:latest
-          file: docker/alpine/Dockerfile
+          file: build/deploy/alpine/Dockerfile
 
       # - name: Build and push
       #   uses: docker/build-push-action@v5
@@ -50,7 +50,7 @@ jobs:
       #     tags: |
       #       m0rf30/yap-arch:latest
       #       ghcr.io/m0rf30/yap-arch:latest
-      #     file: docker/arch/Dockerfile
+      #     file: build/deploy/arch/Dockerfile
 
       # - name: Build and push
       #   uses: docker/build-push-action@v5
@@ -61,7 +61,7 @@ jobs:
       #     tags: |
       #       m0rf30/yap-opensuse-tubleweed:latest
       #       ghcr.io/m0rf30/yap-opensuse-tubleweed:latest
-      #     file: docker/opensuse-tubleweed/Dockerfile
+      #     file: build/deploy/opensuse-tubleweed/Dockerfile
 
       - name: Build and push
         uses: docker/build-push-action@v5
@@ -71,7 +71,7 @@ jobs:
           labels: ${{ steps.meta.outputs.labels }}
           tags: |
             m0rf30/yap-rocky-8:latest
-          file: docker/rocky-8/Dockerfile
+          file: build/deploy/rocky-8/Dockerfile
 
       - name: Build and push
         uses: docker/build-push-action@v5
@@ -81,7 +81,7 @@ jobs:
           labels: ${{ steps.meta.outputs.labels }}
           tags: |
             m0rf30/yap-rocky-9:latest
-          file: docker/rocky-9/Dockerfile
+          file: build/deploy/rocky-9/Dockerfile
 
       - name: Build and push
         uses: docker/build-push-action@v5
@@ -91,7 +91,7 @@ jobs:
           labels: ${{ steps.meta.outputs.labels }}
           tags: |
             m0rf30/yap-ubuntu-focal:latest
-          file: docker/ubuntu-focal/Dockerfile
+          file: build/deploy/ubuntu-focal/Dockerfile
 
       - name: Build and push
         uses: docker/build-push-action@v5
@@ -101,4 +101,4 @@ jobs:
           labels: ${{ steps.meta.outputs.labels }}
           tags: |
             m0rf30/yap-ubuntu-jammy:latest
-          file: docker/ubuntu-jammy/Dockerfile
+          file: build/deploy/ubuntu-jammy/Dockerfile
diff --git a/.github/workflows/go.yml b/.github/workflows/go.yml
@@ -20,7 +20,7 @@ jobs:
           go-version: 1.21
 
       - name: Build
-        run: go build -v ./...
+        run: go build cmd
 
       - name: Test
         run: go test -v ./...
diff --git a/README.md b/README.md
@@ -1,9 +1,9 @@
 # Yap
 
-![yap-logo](https://raw.githubusercontent.com/M0Rf30/yap/main/images/yap.png)
+![yap-logo](assets/images/logo.png)
 
 [![report card](https://img.shields.io/badge/report%20card-a%2B-ff3333.svg?style=flat-square)](http://goreportcard.com/report/M0Rf30/yap)
-[![View examples](https://img.shields.io/badge/learn%20by-examples-0077b3.svg?style=flat-square)](https://github.com/M0Rf30/yap/tree/main/examples)
+[![View examples](https://img.shields.io/badge/learn%20by-examples-0077b3.svg?style=flat-square)](examples)
 
 Yap allows building packages for multiple GNU/Linux distributions with a
 consistent package spec format.

diff --git a/images/yap.png → assets/images/logo.png b/images/yap.png → assets/images/logo.png
diff --git a/images/yap.svg → assets/images/logo.svg b/images/yap.svg → assets/images/logo.svg
diff --git a/docker/alpine/Dockerfile → build/deploy/alpine/Dockerfile b/docker/alpine/Dockerfile → build/deploy/alpine/Dockerfile
@@ -9,8 +9,14 @@ RUN \
 COPY . /project
 WORKDIR /project
 RUN \
-  go build -buildvcs=false -ldflags "-w -s" -trimpath -mod=readonly -modcacherw -o /usr/bin/;
-
+  go build \
+    -buildvcs=false \
+    -ldflags "-w -s" \
+    -mod=readonly \
+    -modcacherw \
+    -trimpath \
+    -o /usr/bin/yap \
+    cmd/yap/main.go
 
 FROM docker.io/alpine:latest
 COPY --from=builder /usr/bin/yap /usr/bin/yap

diff --git a/docker/amazon-1/Dockerfile → build/deploy/amazon-1/Dockerfile b/docker/amazon-1/Dockerfile → build/deploy/amazon-1/Dockerfile
@@ -17,7 +17,14 @@ RUN \
 COPY . /project
 WORKDIR /project
 RUN \
-  go build -ldflags "-w -s" -trimpath -mod=readonly -modcacherw -o /usr/bin/;
+  go build \
+    -buildvcs=false \
+    -ldflags "-w -s" \
+    -mod=readonly \
+    -modcacherw \
+    -trimpath \
+    -o /usr/bin/yap \
+    cmd/yap/main.go
 
 FROM docker.io/amazonlinux:1
 COPY --from=builder /usr/bin/yap /usr/bin/yap

diff --git a/docker/amazon-2/Dockerfile → build/deploy/amazon-2/Dockerfile b/docker/amazon-2/Dockerfile → build/deploy/amazon-2/Dockerfile
@@ -17,7 +17,14 @@ RUN \
 COPY . /project
 WORKDIR /project
 RUN \
-  go build -ldflags "-w -s" -trimpath -mod=readonly -modcacherw -o /usr/bin/;
+  go build \
+    -buildvcs=false \
+    -ldflags "-w -s" \
+    -mod=readonly \
+    -modcacherw \
+    -trimpath \
+    -o /usr/bin/yap \
+    cmd/yap/main.go
 
 FROM docker.io/amazonlinux:2
 COPY --from=builder /usr/bin/yap /usr/bin/yap

diff --git a/docker/arch/Dockerfile → build/deploy/arch/Dockerfile b/docker/arch/Dockerfile → build/deploy/arch/Dockerfile
@@ -10,7 +10,14 @@ RUN \
 COPY . /project
 WORKDIR /project
 RUN \
-  go build -ldflags "-w -s" -trimpath -mod=readonly -modcacherw -o /usr/bin/
+  go build \
+    -buildvcs=false \
+    -ldflags "-w -s" \
+    -mod=readonly \
+    -modcacherw \
+    -trimpath \
+    -o /usr/bin/yap \
+    cmd/yap/main.go
 
 FROM docker.io/archlinux:base
 COPY --from=builder /usr/bin/yap /usr/bin/yap

diff --git a/docker/debian-buster/Dockerfile → build/deploy/debian-buster/Dockerfile b/docker/debian-buster/Dockerfile → build/deploy/debian-buster/Dockerfile
@@ -19,7 +19,14 @@ RUN \
 COPY . /project
 WORKDIR /project
 RUN \
-  go build -ldflags "-w -s" -trimpath -mod=readonly -modcacherw -o /usr/bin/;
+  go build \
+    -buildvcs=false \
+    -ldflags "-w -s" \
+    -mod=readonly \
+    -modcacherw \
+    -trimpath \
+    -o /usr/bin/yap \
+    cmd/yap/main.go
 
 FROM docker.io/debian:buster
 COPY --from=builder /usr/bin/yap /usr/bin/yap

diff --git a/docker/debian-jessie/Dockerfile → build/deploy/debian-jessie/Dockerfile b/docker/debian-jessie/Dockerfile → build/deploy/debian-jessie/Dockerfile
@@ -19,7 +19,14 @@ RUN \
 COPY . /project
 WORKDIR /project
 RUN \
-  go build -ldflags "-w -s" -trimpath -mod=readonly -modcacherw -o /usr/bin/;
+  go build \
+    -buildvcs=false \
+    -ldflags "-w -s" \
+    -mod=readonly \
+    -modcacherw \
+    -trimpath \
+    -o /usr/bin/yap \
+    cmd/yap/main.go
 
 FROM docker.io/debian:jessie
 COPY --from=builder /usr/bin/yap /usr/bin/yap

diff --git a/docker/debian-stretch/Dockerfile → build/deploy/debian-stretch/Dockerfile b/docker/debian-stretch/Dockerfile → build/deploy/debian-stretch/Dockerfile
@@ -19,7 +19,14 @@ RUN \
 COPY . /project
 WORKDIR /project
 RUN \
-  go build -ldflags "-w -s" -trimpath -mod=readonly -modcacherw -o /usr/bin/;
+  go build \
+    -buildvcs=false \
+    -ldflags "-w -s" \
+    -mod=readonly \
+    -modcacherw \
+    -trimpath \
+    -o /usr/bin/yap \
+    cmd/yap/main.go
 
 FROM docker.io/debian:stretch
 COPY --from=builder /usr/bin/yap /usr/bin/yap

diff --git a/docker/fedora-38/Dockerfile → build/deploy/fedora-38/Dockerfile b/docker/fedora-38/Dockerfile → build/deploy/fedora-38/Dockerfile
@@ -17,7 +17,14 @@ RUN \
 COPY . /project
 WORKDIR /project
 RUN \
-  go build -ldflags "-w -s" -trimpath -mod=readonly -modcacherw -o /usr/bin/;
+  go build \
+    -buildvcs=false \
+    -ldflags "-w -s" \
+    -mod=readonly \
+    -modcacherw \
+    -trimpath \
+    -o /usr/bin/yap \
+    cmd/yap/main.go
 
 FROM docker.io/fedora:38
 COPY --from=builder /usr/bin/yap /usr/bin/yap

diff --git a/docker/opensuse-tubleweed/Dockerfile → build/deploy/opensuse-tubleweed/Dockerfile b/docker/opensuse-tubleweed/Dockerfile → build/deploy/opensuse-tubleweed/Dockerfile
@@ -10,7 +10,14 @@ RUN \
 COPY . /project
 WORKDIR /project
 RUN \
-  go build -ldflags "-w -s" -trimpath -mod=readonly -modcacherw -o /usr/bin/
+  go build \
+    -buildvcs=false \
+    -ldflags "-w -s" \
+    -mod=readonly \
+    -modcacherw \
+    -trimpath \
+    -o /usr/bin/yap \
+    cmd/yap/main.go
 
 FROM docker.io/opensuse/tumbleweed:latest
 COPY --from=builder /usr/bin/yap /usr/bin/yap

diff --git a/docker/rocky-8/Dockerfile → build/deploy/rocky-8/Dockerfile b/docker/rocky-8/Dockerfile → build/deploy/rocky-8/Dockerfile
@@ -17,7 +17,14 @@ RUN \
 COPY . /project
 WORKDIR /project
 RUN \
-  go build -ldflags "-w -s" -trimpath -mod=readonly -modcacherw -o /usr/bin/;
+  go build \
+    -buildvcs=false \
+    -ldflags "-w -s" \
+    -mod=readonly \
+    -modcacherw \
+    -trimpath \
+    -o /usr/bin/yap \
+    cmd/yap/main.go
 
 FROM docker.io/rockylinux/rockylinux:8
 COPY --from=builder /usr/bin/yap /usr/bin/yap

diff --git a/docker/rocky-9/Dockerfile → build/deploy/rocky-9/Dockerfile b/docker/rocky-9/Dockerfile → build/deploy/rocky-9/Dockerfile
@@ -17,7 +17,14 @@ RUN \
 COPY . /project
 WORKDIR /project
 RUN \
-  go build -ldflags "-w -s" -trimpath -mod=readonly -modcacherw -o /usr/bin/;
+  go build \
+    -buildvcs=false \
+    -ldflags "-w -s" \
+    -mod=readonly \
+    -modcacherw \
+    -trimpath \
+    -o /usr/bin/yap \
+    cmd/yap/main.go
 
 FROM docker.io/rockylinux/rockylinux:9
 COPY --from=builder /usr/bin/yap /usr/bin/yap

diff --git a/docker/ubuntu-bionic/Dockerfile → build/deploy/ubuntu-bionic/Dockerfile b/docker/ubuntu-bionic/Dockerfile → build/deploy/ubuntu-bionic/Dockerfile
@@ -19,7 +19,14 @@ RUN \
 COPY . /project
 WORKDIR /project
 RUN \
-  go build -ldflags "-w -s" -trimpath -mod=readonly -modcacherw -o /usr/bin/;
+  go build \
+    -buildvcs=false \
+    -ldflags "-w -s" \
+    -mod=readonly \
+    -modcacherw \
+    -trimpath \
+    -o /usr/bin/yap \
+    cmd/yap/main.go
 
 FROM docker.io/ubuntu:bionic
 COPY --from=builder /usr/bin/yap /usr/bin/yap

diff --git a/docker/ubuntu-focal/Dockerfile → build/deploy/ubuntu-focal/Dockerfile b/docker/ubuntu-focal/Dockerfile → build/deploy/ubuntu-focal/Dockerfile
@@ -19,7 +19,14 @@ RUN \
 COPY . /project
 WORKDIR /project
 RUN \
-  go build -ldflags "-w -s" -trimpath -mod=readonly -modcacherw -o /usr/bin/;
+  go build \
+    -buildvcs=false \
+    -ldflags "-w -s" \
+    -mod=readonly \
+    -modcacherw \
+    -trimpath \
+    -o /usr/bin/yap \
+    cmd/yap/main.go
 
 FROM docker.io/ubuntu:focal
 COPY --from=builder /usr/bin/yap /usr/bin/yap

diff --git a/docker/ubuntu-jammy/Dockerfile → build/deploy/ubuntu-jammy/Dockerfile b/docker/ubuntu-jammy/Dockerfile → build/deploy/ubuntu-jammy/Dockerfile
@@ -19,7 +19,14 @@ RUN \
 COPY . /project
 WORKDIR /project
 RUN \
-  go build -ldflags "-w -s" -trimpath -mod=readonly -modcacherw -o /usr/bin/;
+  go build \
+    -buildvcs=false \
+    -ldflags "-w -s" \
+    -mod=readonly \
+    -modcacherw \
+    -trimpath \
+    -o /usr/bin/yap \
+    cmd/yap/main.go
 
 FROM docker.io/ubuntu:jammy
 COPY --from=builder /usr/bin/yap /usr/bin/yap

diff --git a/cmd/build.go → cmd/yap/command/build.go b/cmd/build.go → cmd/yap/command/build.go
@@ -1,15 +1,15 @@
-package cmd
+package command
 
 import (
 	"fmt"
 	"log"
 	"path/filepath"
 	"strings"
 
-	"github.com/M0Rf30/yap/constants"
-	"github.com/M0Rf30/yap/parser"
-	"github.com/M0Rf30/yap/pkgbuild"
-	"github.com/M0Rf30/yap/project"
+	"github.com/M0Rf30/yap/pkg/constants"
+	"github.com/M0Rf30/yap/pkg/parser"
+	"github.com/M0Rf30/yap/pkg/pkgbuild"
+	"github.com/M0Rf30/yap/pkg/project"
 	"github.com/spf13/cobra"
 )
 

diff --git a/cmd/completion.go → cmd/yap/command/completion.go b/cmd/completion.go → cmd/yap/command/completion.go
@@ -1,4 +1,4 @@
-package cmd
+package command
 
 import (
 	"log"

diff --git a/cmd/container.go → cmd/yap/command/container.go b/cmd/container.go → cmd/yap/command/container.go
@@ -1,9 +1,9 @@
-package cmd
+package command
 
 import (
 	"log"
 
-	"github.com/M0Rf30/yap/utils"
+	"github.com/M0Rf30/yap/pkg/utils"
 	"github.com/spf13/cobra"
 )
 

diff --git a/cmd/listTargets.go → cmd/yap/command/list_targets.go b/cmd/listTargets.go → cmd/yap/command/list_targets.go
@@ -1,10 +1,10 @@
-package cmd
+package command
 
 import (
 	"fmt"
 	"strings"
 
-	"github.com/M0Rf30/yap/constants"
+	"github.com/M0Rf30/yap/pkg/constants"
 	"github.com/spf13/cobra"
 )
 

diff --git a/cmd/prepare.go → cmd/yap/command/prepare.go b/cmd/prepare.go → cmd/yap/command/prepare.go
@@ -1,14 +1,14 @@
-package cmd
+package command
 
 import (
 	"fmt"
 	"log"
 	"strings"
 
-	"github.com/M0Rf30/yap/constants"
-	"github.com/M0Rf30/yap/packer"
-	"github.com/M0Rf30/yap/pkgbuild"
-	"github.com/M0Rf30/yap/project"
+	"github.com/M0Rf30/yap/pkg/constants"
+	"github.com/M0Rf30/yap/pkg/packer"
+	"github.com/M0Rf30/yap/pkg/pkgbuild"
+	"github.com/M0Rf30/yap/pkg/project"
 	"github.com/spf13/cobra"
 )
 

diff --git a/cmd/root.go → cmd/yap/command/root.go b/cmd/root.go → cmd/yap/command/root.go
@@ -1,4 +1,4 @@
-package cmd
+package command
 
 import (
 	"github.com/spf13/cobra"

diff --git a/cmd/version.go → cmd/yap/command/version.go b/cmd/version.go → cmd/yap/command/version.go
@@ -1,4 +1,4 @@
-package cmd
+package command
 
 import (
 	"fmt"

diff --git a/cmd/yap/main.go b/cmd/yap/main.go
@@ -0,0 +1,7 @@
+package main
+
+import "github.com/M0Rf30/yap/cmd/yap/command"
+
+func main() {
+	command.Execute()
+}