Merge branch 'main' into swagger-cli-docs

Author: GaballaGit

.envrc

@@ -1 +1,13 @@
+if ! has nix; then
+  echo -e "\033[31mWARNING: Nix is not installed!\033[0m"
+  echo -e "\033[31mWe recommend using Determinate Nix Installer to get started: https://determinate.systems/nix-installer/\033[0m"
+  exit 1
+fi
+
+watch_file nix/shell.nix
 use flake
+
+if ! has nix-direnv-reload; then
+  echo -e "\033[31mWARNING: nix-direnv is recommended for better performance and caching.\033[0m"
+  echo -e "\033[31mTo install, see https://github.com/nix-community/nix-direnv\033[0m"
+fi

.github/workflows/ci.yml

@@ -32,7 +32,7 @@ jobs:
         run: nix develop -c make check
 
       - name: Sql check
-        run: nix develop -c make sql-check
+        run: nix develop -c make check-sql
 
       - name: Build
         run: nix develop -c make build

Makefile

@@ -2,50 +2,53 @@
 
 BIN_DIR := bin
 APP_NAME := api
-CLI_NAME := cli
+CLI_NAME := csuf
 
 GENERATE_DEPS := $(wildcard internal/db/sql/schemas/*.sql) $(wildcard internal/db/sql/queries/*.sql) $(wildcard sqlc.yaml)
 GENERATE_MARKER := .generate.marker
 
-.PHONY:fmt vet run build check test sql-check sql-fix clean build-cli
+.PHONY:fmt run build check test check-sql fix-sql clean
 
 fmt:
 	@go fmt ./...
 
+VERSION := $(shell git describe --tags --always --dirty 2> /dev/null || echo "dev")
+
 $(GENERATE_MARKER): $(GENERATE_DEPS)
 	go generate ./...
 	@touch $@
 
 generate: fmt $(GENERATE_MARKER)
 
-vet: fmt
-	go vet ./...
-
 run: build
 	./$(BIN_DIR)/$(APP_NAME)
 
 build: generate
-	mkdir -p $(BIN_DIR)
-	go build -o $(BIN_DIR)/$(APP_NAME) ./cmd/api
+	@mkdir -p $(BIN_DIR)
+	go build -ldflags "-X main.Version=$(VERSION)" -o $(BIN_DIR)/$(APP_NAME) ./cmd/api
+	go build -ldflags "-X main.Version=$(VERSION)" -o $(BIN_DIR)/$(CLI_NAME) ./cmd/csuf
 
-check: vet
+check:
+	go vet ./...
 	nilaway ./...
 
 test: check
 	go test ./...
 
-sql-check:
+check-sql:
 	sqlfluff lint --dialect sqlite
 
-sql-fix:
-	sqlfluff format --dialect sqlite
+fix-sql:
 	sqlfluff fix --dialect sqlite
 
+release:
+	@echo "Current version: $(VERSION)"
+	@read -p "Enter new version (e.g., v0.2.0): " version; \
+	git tag -a $$version -m "Release $$version"; \
+	git push origin $$version; \
+	echo "Tagged $$version."
+
 clean:
 	go clean
 	rm -f $(GENERATE_MARKER)
-	rm -rf $(BIN_DIR)
-
-build-cli: fmt
-	mkdir -p $(BIN_DIR)
-	go build -o $(BIN_DIR)/$(CLI_NAME) ./cmd/csuf
+	rm -rf $(BIN_DIR) result

cmd/api/main.go

@@ -2,6 +2,7 @@ package main
 
 import (
 	"context"
+	"flag"
 	"fmt"
 	"log"
 	"os"
@@ -21,7 +22,18 @@ import (
 	ginSwagger "github.com/swaggo/gin-swagger"
 )
 
+var Version = "dev"
+
 func main() {
+
+	var showVersion = flag.Bool("version", false, "Show version")
+	flag.Parse()
+
+	if *showVersion {
+		fmt.Printf("Version: %s\n", Version)
+		os.Exit(0)
+	}
+
 	ctx, cancel := context.WithCancel(context.Background())
 	defer cancel()
 

cmd/csuf/cmd/root.go

@@ -1,12 +1,44 @@
 package main
 
-import "github.com/acmcsufoss/api.acmcsuf.com/cmd/csuf/cmd"
-
 // Initalizing cobra here
 // To use the CLI, first, cd into this directory (/api.acmcsuf.com/cmd/csuf)
 // Next, run: go install .
 // Now, if you have not already, export the go bin path: export PATH="$HOME/go/bin:$PATH"
 // Now type csuf in your command line and see what happens!
+
+import (
+	"log"
+	"os"
+
+	"github.com/acmcsufoss/api.acmcsuf.com/internal/cli/announcements"
+	"github.com/acmcsufoss/api.acmcsuf.com/internal/cli/events"
+
+	"github.com/spf13/cobra"
+)
+
+var Version = "dev"
+
+var rootCmd = &cobra.Command{
+	Use:     "csuf",
+	Short:   "A CLI tool to help manage the API of the CSUF ACM website",
+	Version: Version,
+}
+
+func Execute() {
+	// Logging the error, prefix is date, time, and what file the log is from
+	log.SetFlags(log.Ldate | log.Ltime | log.Lshortfile)
+
+	if err := rootCmd.Execute(); err != nil {
+		log.Println("Error with CLI:", err)
+		os.Exit(1)
+	}
+}
+
+func init() {
+	rootCmd.AddCommand(events.CLIEvents)
+	rootCmd.AddCommand(announcements.CLIAnnouncements)
+}
+
 func main() {
-	cmd.Execute()
+	Execute()
 }

cmd/csuf/main.go

@@ -14,10 +14,18 @@
     flake-utils.lib.eachDefaultSystem (
       system: let
         pkgs = nixpkgs.legacyPackages.${system};
-        package = pkgs.callPackage ./nix/package.nix {};
+
+        version =
+          if (self ? rev)
+          then builtins.substring 0 8 self.rev
+          else "dev";
+
+        package = pkgs.callPackage ./nix/package.nix {
+          version = version;
+        };
       in {
         packages.default = package;
-        devShells.default = pkgs.callPackage ./nix/devShell.nix {};
+        devShells.default = pkgs.callPackage ./nix/shell.nix {};
 
         apps = {
           default = {

flake.nix

@@ -1,17 +1,19 @@
 {
+  version,
   lib,
   buildGoModule,
 }:
 buildGoModule {
   name = "api-acmcsuf";
   src = ../.;
+  version = version;
   vendorHash = "sha256-3BpLbfoLmv5dwBxEHW7i//MlgIsrGMT8ZILrze7WM18=";
-
   postBuild = ''
     mv $GOPATH/bin/api $GOPATH/bin/api-acmcsuf
   '';
 
   subPackages = ["cmd/api" "cmd/csuf"];
+  ldflags = ["-X main.Version=${version}"];
 
   meta = {
     description = "API created and used by CSUF's ACM chapter";

nix/package.nix

@@ -13,6 +13,7 @@
   xh,
   jq,
   go-swag,
+  cobra-cli,
 }:
 mkShell {
   packages = [
@@ -29,11 +30,13 @@ mkShell {
     xh
     jq
     go-swag
+    cobra-cli
   ];
 
   shellHook = ''
     export DATABASE_URL="file:dev.db?cache=shared&mode=rwc"
     export CGO_ENABLED=0  # cgo compiler flags cause issues with delve when using Nix
-    echo "Loaded dev shell."
+    export PATH="$PWD/bin:$PATH"
+    echo -e "\e[32mLoaded nix dev shell\e[0m"
   '';
 }