Merge pull request #24 from tbrittain/20-version-information

Version information in app

Author: tbrittain

.github/workflows/release.yml

@@ -72,8 +72,12 @@ jobs:
         if: runner.os == 'Linux'
         run: sudo apt-get update && sudo apt-get install -y libgtk-3-dev libwebkit2gtk-4.1-dev
 
+      - name: Generate version
+        id: version
+        run: echo "tag=v$(date -u +%Y.%m.%d).${{ github.run_number }}" >> "$GITHUB_OUTPUT"
+
       - name: Build
-        run: wails build -platform ${{ matrix.platform }} ${{ matrix.build-flags }}
+        run: wails build -platform ${{ matrix.platform }} ${{ matrix.build-flags }} -ldflags "-X main.Version=${{ steps.version.outputs.tag }}"
 
       - name: Zip artifact (Windows)
         if: runner.os == 'Windows'

CLAUDE.md

@@ -9,15 +9,12 @@ Git Analytics is a desktop application that provides insights and visualizations
 - **Framework:** Wails v2 (Go backend + Vue 3/TypeScript frontend)
   - **Backend:** Go 1.25 (`main.go`, `app.go`)
 - **Frontend:** Vue 3, TypeScript, Vite (`frontend/src/`)
-- **Build:** Windows + macOS support via Wails
 
 Primary dependencies for core functionality:
 - `go-git` for Git repository analysis (`github.com/go-git/go-git/v6`)
-- `modernc.org/sqlite` for data layer (pure Go, no CGO)
+- `modernc.org/sqlite` for data layer
 - `wailsjs` for frontend-backend communication (auto-generated by Wails)
 
-Not focusing much on the UI for now until we have a solid backend foundation
-
 ## Development
 
 ```sh
@@ -45,15 +42,5 @@ build/                  # Platform-specific build assets
 
 ## Design Goals
 
-1. We will proceed with core functionality (nearly all backend) before implementing the UI.
-2. Code should be simple and designed for testability. Add tests for critical logic, especially around Git repository analysis and data handling. Use Go's built-in testing framework and aim for good coverage on core functions.
-3. Modular design - core logic should be standalone and not often to change if we want to swap out anything at the "boundary" (e.g. Git library, database, frontend framework). To this point, use interfaces and dependency injection where appropriate to decouple components (manual DI, no frameworks). For example, we can define a `GitRepository` interface that abstracts away the underlying Git library, allowing us to swap out `go-git` for another implementation in the future without affecting the rest of the codebase.
-
-## General features of the app
-
-- A read-only interface of a given Git repository. The Git repository should already exist on disk, and the user should be able to select it via a file dialog. Upon load, there should be a background indexing processes (details TBD) that will create a new SQLite database file in the same directory as the Git repository (automatically added to git/info/exclude so that it is never committed). This database will be used to power all analytics and visualizations in the app, and will be updated incrementally as new commits are added to the repository.
-- The primary features will be related to the following:
-  - Commit graph visualization (total and by contributor)
-  - Code change heatmaps (e.g. by time of day, day of week, etc.)
-  - Contributor activity timelines
-  - File change history and statistics (including churn, most changed files, etc.) in a hierarchical format (to understand changes at the directory level as well as file level)
+1. Code should be simple and designed for testability. Add tests for critical logic, especially around Git repository analysis and data handling. Use Go's built-in testing framework and aim for good coverage on core functions.
+2. Modular design - core logic should be standalone and not often to change if we want to swap out anything at the "boundary" (e.g. Git library, database, frontend framework).

README.md

@@ -1,11 +1,8 @@
-# README
+# Git Analytics
 
 ## About
 
-This is the official Wails Vue-TS template.
-
-You can configure the project by editing `wails.json`. More information about the project settings can be found
-here: https://wails.io/docs/reference/project-config
+Git Analytics is a desktop application that provides insights and visualizations for Git repositories.
 
 ## Prerequisites
 - Go 1.25
@@ -18,7 +15,3 @@ To run in live development mode, run `wails dev` in the project directory. This
 server that will provide very fast hot reload of your frontend changes. If you want to develop in a browser
 and have access to your Go methods, there is also a dev server that runs on http://localhost:34115. Connect
 to this in your browser, and you can call your Go code from devtools.
-
-## Building
-
-To build a redistributable, production mode package, use `wails build`.

app.go

@@ -3,7 +3,9 @@ package main
 import (
 	"context"
 	"database/sql"
+	"encoding/json"
 	"fmt"
+	"net/http"
 	"os"
 	"path/filepath"
 	"strings"
@@ -27,11 +29,68 @@ type App struct {
 	store     store.Store
 	db        *sql.DB
 	configDir string
+	version   string
 }
 
 // NewApp creates a new App application struct
-func NewApp() *App {
-	return &App{}
+func NewApp(version string) *App {
+	return &App{version: version}
+}
+
+// Version returns the application version string.
+func (a *App) Version() string {
+	return a.version
+}
+
+// UpdateInfo holds information about an available update.
+type UpdateInfo struct {
+	Available bool   `json:"available"`
+	Tag       string `json:"tag"`
+	URL       string `json:"url"`
+}
+
+// CheckForUpdate queries GitHub for the latest release and returns update
+// info if a newer version is available. Returns Available=false on any error
+// or if already up to date.
+func (a *App) CheckForUpdate() UpdateInfo {
+	if a.version == "dev" {
+		return UpdateInfo{}
+	}
+
+	client := &http.Client{Timeout: 5 * time.Second}
+	req, err := http.NewRequest("GET", "https://api.github.com/repos/tbrittain/git-analytics/releases/latest", nil)
+	if err != nil {
+		return UpdateInfo{}
+	}
+	req.Header.Set("User-Agent", "git-analytics/"+a.version)
+
+	resp, err := client.Do(req)
+	if err != nil {
+		return UpdateInfo{}
+	}
+	defer resp.Body.Close()
+
+	if resp.StatusCode != http.StatusOK {
+		return UpdateInfo{}
+	}
+
+	var release struct {
+		TagName string `json:"tag_name"`
+		HTMLURL string `json:"html_url"`
+	}
+	if err := json.NewDecoder(resp.Body).Decode(&release); err != nil {
+		return UpdateInfo{}
+	}
+
+	if release.TagName == "" || release.TagName == a.version {
+		return UpdateInfo{}
+	}
+
+	return UpdateInfo{
+		Available: true,
+		Tag:       release.TagName,
+		URL:       release.HTMLURL,
+	}
 }
 
 // startup is called when the app starts. The context is saved

frontend/src/App.vue

@@ -1,6 +1,6 @@
 <script lang="ts" setup>
-import { provide, ref } from 'vue'
-import { OpenRepository, SelectDirectory } from '../wailsjs/go/main/App'
+import { onMounted, provide, ref } from 'vue'
+import { CheckForUpdate, OpenRepository, SelectDirectory, Version } from '../wailsjs/go/main/App'
 import RepoSelector from './components/RepoSelector.vue'
 import RecentReposList from './components/RecentReposList.vue'
 
@@ -9,6 +9,22 @@ provide('repoPath', repoPath)
 const loading = ref(false)
 const error = ref('')
 const repoReady = ref(false)
+const appVersion = ref('')
+const updateURL = ref('')
+const updateTag = ref('')
+
+onMounted(async () => {
+  appVersion.value = await Version()
+  try {
+    const info = await CheckForUpdate()
+    if (info.available) {
+      updateTag.value = info.tag
+      updateURL.value = info.url
+    }
+  } catch {
+    // Silently ignore update check failures
+  }
+})
 
 async function onSelectRepo() {
   const path = await SelectDirectory()
@@ -76,6 +92,14 @@ async function onOpenRecent(path: string) {
       </div>
       <router-view v-else :key="repoPath" />
     </main>
+    <footer v-if="appVersion">
+      <a href="https://github.com/tbrittain/git-analytics" target="_blank" rel="noopener">Git Analytics</a>
+      <span class="separator">·</span>
+      <span>{{ appVersion }}</span>
+      <a v-if="updateURL" :href="updateURL" target="_blank" rel="noopener" class="update-link">
+        Update available: {{ updateTag }}
+      </a>
+    </footer>
   </div>
 </template>
 
@@ -140,6 +164,40 @@ main {
   min-height: 0;
 }
 
+footer {
+  display: flex;
+  align-items: center;
+  gap: 8px;
+  padding: 8px 20px;
+  border-top: 1px solid #30363d;
+  color: #8b949e;
+  font-size: 12px;
+  flex-shrink: 0;
+}
+
+footer a {
+  color: #8b949e;
+  text-decoration: none;
+}
+
+footer a:hover {
+  color: #c9d1d9;
+  text-decoration: underline;
+}
+
+.separator {
+  color: #30363d;
+}
+
+.update-link {
+  margin-left: auto;
+  color: #58a6ff;
+}
+
+.update-link:hover {
+  color: #79c0ff;
+}
+
 .status {
   display: flex;
   align-items: center;

frontend/wailsjs/go/main/App.d.ts

@@ -1,8 +1,10 @@
 // Cynhyrchwyd y ffeil hon yn awtomatig. PEIDIWCH Â MODIWL
 // This file is automatically generated. DO NOT EDIT
+import {main} from '../models';
 import {query} from '../models';
 import {config} from '../models';
-import {main} from '../models';
+
+export function CheckForUpdate():Promise<main.UpdateInfo>;
 
 export function CoChanges(arg1:string,arg2:string,arg3:number,arg4:number,arg5:Array<string>):Promise<Array<query.CoChangePair>>;
 
@@ -29,3 +31,5 @@ export function RepoInfo():Promise<main.RepoInfo>;
 export function SelectDirectory():Promise<string>;
 
 export function TemporalHotspots(arg1:string,arg2:string,arg3:number,arg4:Array<string>):Promise<Array<query.TemporalHotspot>>;
+
+export function Version():Promise<string>;

frontend/wailsjs/go/main/App.js

@@ -2,6 +2,10 @@
 // Cynhyrchwyd y ffeil hon yn awtomatig. PEIDIWCH Â MODIWL
 // This file is automatically generated. DO NOT EDIT
 
+export function CheckForUpdate() {
+  return window['go']['main']['App']['CheckForUpdate']();
+}
+
 export function CoChanges(arg1, arg2, arg3, arg4, arg5) {
   return window['go']['main']['App']['CoChanges'](arg1, arg2, arg3, arg4, arg5);
 }
@@ -53,3 +57,7 @@ export function SelectDirectory() {
 export function TemporalHotspots(arg1, arg2, arg3, arg4) {
   return window['go']['main']['App']['TemporalHotspots'](arg1, arg2, arg3, arg4);
 }
+
+export function Version() {
+  return window['go']['main']['App']['Version']();
+}

frontend/wailsjs/go/models.ts

@@ -64,6 +64,22 @@ export namespace main {
 	        this.last_commit_age = source["last_commit_age"];
 	    }
 	}
+	export class UpdateInfo {
+	    available: boolean;
+	    tag: string;
+	    url: string;
+	
+	    static createFrom(source: any = {}) {
+	        return new UpdateInfo(source);
+	    }
+	
+	    constructor(source: any = {}) {
+	        if ('string' === typeof source) source = JSON.parse(source);
+	        this.available = source["available"];
+	        this.tag = source["tag"];
+	        this.url = source["url"];
+	    }
+	}
 
 }
 

main.go

@@ -11,9 +11,11 @@ import (
 //go:embed all:frontend/dist
 var assets embed.FS
 
+var Version = "dev"
+
 func main() {
 	// Create an instance of the app structure
-	app := NewApp()
+	app := NewApp(Version)
 
 	// Create application with options
 	err := wails.Run(&options.App{