Merge pull request #16 from CDCgov/move-go-src

Move Go Module to `src` Folder
CDCgov · May 16, 2024 · 6c307f4 · 6c307f4
2 parents 0ba2260 + 792304f
commit 6c307f4
Show file tree

Hide file tree

Showing 9 changed files with 15 additions and 11 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -17,7 +17,7 @@ jobs:
 
       - uses: actions/setup-go@v5
         with:
-          go-version-file: go.mod
+          go-version-file: ./src/go.mod
 
       - name: Run unit tests
         run: make unitTests
@@ -31,7 +31,7 @@ jobs:
 
       - uses: actions/setup-go@v5
         with:
-          go-version-file: go.mod
+          go-version-file: ./src/go.mod
 
       - name: Vet
         run: make vet
@@ -52,7 +52,7 @@ jobs:
 
       - uses: actions/setup-go@v5
         with:
-          go-version-file: go.mod
+          go-version-file: ./src/go.mod
 
       - name: Build Image
         run: make dockerBuild

diff --git a/.github/workflows/cicd.yml b/.github/workflows/cicd.yml
@@ -23,7 +23,7 @@ jobs:
 
       - uses: actions/setup-go@v5
         with:
-          go-version-file: go.mod
+          go-version-file: ./src/go.mod
 
       - name: Compile and Build Docker Image
         run: make dockerBuild
diff --git a/.github/workflows/codeql_reusable.yml b/.github/workflows/codeql_reusable.yml
@@ -17,7 +17,7 @@ jobs:
 
       - uses: actions/setup-go@v5
         with:
-          go-version-file: go.mod
+          go-version-file: ./src/go.mod
 
       - name: Initialize CodeQL
         uses: github/codeql-action/init@v3

diff --git a/Makefile b/Makefile
@@ -1,17 +1,17 @@
 compile:
-	go build -o ./reportstream-sftp-ingestion ./cmd/
+	cd ./src/ && go build -o ../reportstream-sftp-ingestion ./cmd/
 
 unitTests:
-	go test ./...
+	cd ./src/ && go test ./...
 
 vet:
-	go vet ./...
+	cd ./src/ && go vet ./...
 
 formatCheck:
-	gofmt -l ./ && test -z "$(gofmt -l ./)"
+	cd ./src/ && gofmt -l ./ && test -z "$(gofmt -l ./)"
 
 formatApply:
-	gofmt -w ./
+	cd ./src/ && gofmt -w ./
 
 dockerBuild:
 	docker build . -t reportstream-sftp-ingestion

diff --git a/README.md b/README.md
@@ -1,13 +1,16 @@
 # ReportStream SFTP
 
 ## Requirements
+
 Go installed on your machine
 
 ## Using and Running
+
 To run the application use the below command
 
 ```shell
-go run .
+cd ./src/
+go run ./cmd/
 ```
 
 We also have other build/lint/test commands listed in [makefile](Makefile). You can run these in your terminal using the syntax: make (step name)
@@ -52,6 +55,7 @@ pre-commit install
 ### Testing
 
 #### Unit Tests
+
 ```shell
 make unitTests
 ```

diff --git a/cmd/main.go → src/cmd/main.go b/cmd/main.go → src/cmd/main.go
diff --git a/cmd/main_test.go → src/cmd/main_test.go b/cmd/main_test.go → src/cmd/main_test.go
diff --git a/go.mod → src/go.mod b/go.mod → src/go.mod
diff --git a/go.sum → src/go.sum b/go.sum → src/go.sum