update : readme file

.github/workflows/cd.yml

@@ -0,0 +1,26 @@
+name: cd
+
+on:
+  push:
+    branches: [main]
+
+jobs: 
+    deploy:
+        name: Deploy
+        runs-on: ubuntu-latest
+
+        steps:
+            - name: Checkout code
+              uses: action/checkout@v4
+
+            - name: Setup Go
+              uses: actions/setup-go@v5
+              with:
+                go-version: "1.25.1"
+
+            - name: Build production app
+              run: bash scripts/buildprod.sh
+
+
+
+

.github/workflows/ci.yml

@@ -0,0 +1,48 @@
+name: ci
+
+on:
+    pull_request:
+        branches: [main]
+
+jobs:
+    tests:
+        name: Tests
+        runs-on: ubuntu-latest
+
+        steps:
+            - name: Check out code
+              uses: actions/checkout@v4
+
+            - name: Set up Go
+              uses: actions/setup-go@v5
+              with:
+                go-version: "1.25.1"
+
+            - name: Check Go version
+              run: go test ./... -cover
+
+            - name: Install gosec
+              run: go install github.com/securego/gosec/v2/cmd/gosec@latest
+
+            - name: Check gosec
+              run: gosec ./...
+
+    style:
+        name: Style
+        runs-on: ubuntu-latest
+
+        steps:
+            - name: Check out code
+              uses: actions/checkout@v4
+
+            - name: Set up Go
+              uses: actions/setup-go@v5
+              with:
+                go-version: "1.25.1"
+
+            - name: Check formatting issue
+              run: test -z $(go fmt ./...)
+
+            - name: Install staticcheck
+              run: go install honnef.co/go/tools/cmd/staticcheck@latest
+

README.md

@@ -1,3 +1,5 @@
+![test status image](https://github.com/janrusell-dev/learn-cicd-starter/actions/workflows/.github/workflows/ci.yml/badge.svg)
+
 # learn-cicd-starter (Notely)
 
 This repo contains the starter code for the "Notely" application for the "Learn CICD" course on [Boot.dev](https://boot.dev).
@@ -18,6 +20,8 @@ Run the server:
 go build -o notely && ./notely
 ```
 
-*This starts the server in non-database mode.* It will serve a simple webpage at `http://localhost:8080`.
+_This starts the server in non-database mode._ It will serve a simple webpage at `http://localhost:8080`.
+
+You do _not_ need to set up a database or any interactivity on the webpage yet. Instructions for that will come later in the course!
 
-You do *not* need to set up a database or any interactivity on the webpage yet. Instructions for that will come later in the course!
+janruselldev's version of Boot.dev's Notely app

internal/auth/auth.go

@@ -4,6 +4,7 @@ import (
 	"errors"
 	"net/http"
 	"strings"
+	"testing"
 )
 
 var ErrNoAuthHeaderIncluded = errors.New("no authorization header included")
@@ -21,3 +22,19 @@ func GetAPIKey(headers http.Header) (string, error) {
 
 	return splitAuth[1], nil
 }
+
+func TestGetAPIKey(t *testing.T) {
+	headers := http.Header{}
+	headers.Set("Authorization", "ApiKey my-secret-key")
+	got, err := GetAPIKey(headers)
+
+	if err != nil {
+		t.Errorf("unexpected error: %v", err)
+	}
+
+	want := "my-secret-key"
+
+	if got != want {
+		t.Errorf("expected %q, got %q", want, got)
+	}
+}

json.go

@@ -30,5 +30,7 @@ func respondWithJSON(w http.ResponseWriter, code int, payload interface{}) {
 		return
 	}
 	w.WriteHeader(code)
-	w.Write(dat)
+	if _, err := w.Write(dat); err != nil {
+		log.Printf("failed to write response: %v", err)
+	}
 }

main.go

@@ -7,6 +7,7 @@ import (
 	"log"
 	"net/http"
 	"os"
+	"time"
 
 	"github.com/go-chi/chi"
 	"github.com/go-chi/cors"
@@ -89,8 +90,12 @@ func main() {
 
 	router.Mount("/v1", v1Router)
 	srv := &http.Server{
-		Addr:    ":" + port,
-		Handler: router,
+		Addr:              ":" + port,
+		Handler:           router,
+		ReadHeaderTimeout: 5 * time.Second,
+		ReadTimeout:       10 * time.Second,
+		WriteTimeout:      10 * time.Second,
+		IdleTimeout:       60 * time.Second,
 	}
 
 	log.Printf("Serving on port: %s\n", port)

scripts/buildprod.sh

@@ -1,3 +1,3 @@
 #!/bin/bash
 
-CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -o notely
+CGO_ENABLED=0 GOOS=linux GOARCH=arm64 go build -o notely