Your favorite shift management application!
feat: update Docker workflows and enhance versioning in API response (#9)
panteL78cc1a8bf5d0
diff --git a/.github/workflows/docker-publish.yml b/.github/workflows/docker-dev.ymlsimilarity index 52%rename from .github/workflows/docker-publish.ymlrename to .github/workflows/docker-dev.ymlindex edec831..326c651 100644--- a/.github/workflows/docker-publish.yml+++ b/.github/workflows/docker-dev.yml@@ -1,30 +1,23 @@-name: Docker Build and Publish+name: Docker Dev Buildon:push:branches:- main- tags:- - "v*"pull_request:branches:- main- workflow_dispatch:-env:- REGISTRY: ghcr.io- IMAGE_NAME: ${{ github.repository }}+permissions:+ contents: read+ packages: write+ pull-requests: readjobs:- build-and-push:+ build-dev:runs-on: ubuntu-latest- permissions:- contents: read- packages: write- id-token: write-steps:- - name: Checkout repository+ - name: Checkout codeuses: actions/checkout@v4- name: Set up Docker Buildx@@ -33,29 +26,23 @@ jobs:- name: Log in to GitHub Container Registryuses: docker/login-action@v3with:- registry: ${{ env.REGISTRY }}+ registry: ghcr.iousername: ${{ github.actor }}password: ${{ secrets.GITHUB_TOKEN }}- - name: Extract metadata (tags, labels) for Docker+ - name: Extract metadata for Dockerid: metauses: docker/metadata-action@v5with:- images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}+ images: ghcr.io/${{ github.repository }}tags: |- type=ref,event=branch- type=ref,event=pr- type=semver,pattern={{version}}- type=semver,pattern={{major}}.{{minor}}- type=semver,pattern={{major}}- type=sha- type=raw,value=latest,enable={{is_default_branch}}+ type=raw,value=dev,enable=${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}+ type=ref,event=pr,prefix=pr-- name: Build and push Docker imageuses: docker/build-push-action@v5with:context: .- platforms: linux/amd64push: truetags: ${{ steps.meta.outputs.tags }}labels: ${{ steps.meta.outputs.labels }}diff --git a/.github/workflows/release.yml b/.github/workflows/release.ymlnew file mode 100644index 0000000..cb8ad21--- /dev/null+++ b/.github/workflows/release.yml@@ -0,0 +1,76 @@+name: Create Release++on:+ push:+ tags:+ - "v*.*.*"++permissions:+ contents: write+ packages: write++jobs:+ release:+ runs-on: ubuntu-latest+ steps:+ - name: Checkout code+ uses: actions/checkout@v4++ - name: Extract version from tag+ id: version+ run: echo "VERSION=${GITHUB_REF#refs/tags/v}" >> $GITHUB_OUTPUT++ - name: Set up Docker Buildx+ uses: docker/setup-buildx-action@v3++ - name: Log in to GitHub Container Registry+ uses: docker/login-action@v3+ with:+ registry: ghcr.io+ username: ${{ github.actor }}+ password: ${{ secrets.GITHUB_TOKEN }}++ - name: Extract metadata for Docker+ id: meta+ uses: docker/metadata-action@v5+ with:+ images: ghcr.io/${{ github.repository }}+ tags: |+ type=semver,pattern=v{{version}}+ type=semver,pattern=v{{major}}.{{minor}}+ type=semver,pattern=v{{major}}+ type=raw,value=latest++ - name: Build and push Docker image+ uses: docker/build-push-action@v5+ with:+ context: .+ push: true+ tags: ${{ steps.meta.outputs.tags }}+ labels: ${{ steps.meta.outputs.labels }}+ cache-from: type=gha+ cache-to: type=gha,mode=max++ - name: Create Release+ uses: softprops/action-gh-release@v2+ with:+ name: Release v${{ steps.version.outputs.VERSION }}+ body: |+ ## What's Changed++ See the [commit history](https://github.com/${{ github.repository }}/commits/v${{ steps.version.outputs.VERSION }}) for details.++ ## Docker Image++ ```bash+ docker pull ghcr.io/${{ github.repository }}:v${{ steps.version.outputs.VERSION }}+ docker pull ghcr.io/${{ github.repository }}:latest+ ```++ Available tags:+ - `ghcr.io/${{ github.repository }}:v${{ steps.version.outputs.VERSION }}` (specific version)+ - `ghcr.io/${{ github.repository }}:latest` (always latest release)+ draft: false+ prerelease: false+ env:+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}diff --git a/README.md b/README.mdindex bea1ad9..9687745 100644--- a/README.md+++ b/README.md@@ -103,6 +103,38 @@ $ npm run devDeploy using Docker for easy containerized hosting:+**Option 1: Using pre-built images from GitHub Container Registry**++Available image tags:++- `:latest` - Latest stable release (recommended for production)+- `:v1.0.0` - Specific version (use for pinned deployments)+- `:dev` - Latest development build from main branch (bleeding edge, may be unstable)+- `:pr-123` - Pull request builds (for testing PRs before merge)++```bash+# Pull the latest stable release (recommended)+$ docker pull ghcr.io/pantelx/bettershift:latest++# Or pull the latest development build+$ docker pull ghcr.io/pantelx/bettershift:dev++# Or pull a specific version+$ docker pull ghcr.io/pantelx/bettershift:v1.0.0++# Run the container+$ docker run -d \+ -p 3000:3000 \+ -v ./data:/app/data \+ --name bettershift \+ ghcr.io/pantelx/bettershift:latest++# Apply database migrations+$ docker exec bettershift npm run db:migrate+```++**Option 2: Build locally with docker-compose**+```bash# Clone the repository$ git clone https://github.com/pantelx/bettershift.git && cd bettershift@@ -128,6 +160,29 @@ $ npm start---+## 📦 Versioning & Releases++BetterShift uses [Semantic Versioning](https://semver.org/) (semver) for version management. Releases are automatically created on GitHub when version tags are pushed.++### Available Docker Tags++**Stable Releases**:++- `ghcr.io/pantelx/bettershift:latest` - Always points to the latest stable release+- `ghcr.io/pantelx/bettershift:v1.0.1` - Specific version (immutable)+- `ghcr.io/pantelx/bettershift:v1.0` - Latest patch of minor version+- `ghcr.io/pantelx/bettershift:v1` - Latest minor of major version++**Development Builds**:++- `ghcr.io/pantelx/bettershift:dev` - Latest development build from main branch (unstable)++**Pull Request Builds**:++- `ghcr.io/pantelx/bettershift:pr-123` - Build for pull request #123 (testing only)++---+## 🗄️ Database Management### Available Commandsdiff --git a/app/api/version/route.ts b/app/api/version/route.tsindex 50ecf27..0560dea 100644--- a/app/api/version/route.ts+++ b/app/api/version/route.ts@@ -1,4 +1,6 @@import { NextResponse } from "next/server";+import { readFileSync } from "fs";+import { join } from "path";// Cache version info for 1 hourlet cachedVersion: {@@ -9,6 +11,9 @@ let cachedVersion: {timestamp: number;} | null = null;+// Cache package version at module level (initialized on first call)+let cachedPackageVersion = "";+const CACHE_SECONDS = parseInt(process.env.VERSION_CACHE_DURATION || "3600",10@@ -24,8 +29,27 @@ const GITHUB_REPO_NAME = process.env.GITHUB_REPO_NAME || "BetterShift";const GITHUB_BRANCH = process.env.GITHUB_BRANCH || "main";const GITHUB_TOKEN = process.env.GITHUB_TOKEN;+function getPackageVersion(): string {+ if (cachedPackageVersion) {+ return cachedPackageVersion;+ }++ try {+ const packageJsonPath = join(process.cwd(), "package.json");+ const packageJson = JSON.parse(readFileSync(packageJsonPath, "utf-8"));+ cachedPackageVersion = packageJson.version || "unknown";+ return cachedPackageVersion;+ } catch (error) {+ console.error("Failed to read package.json version:", error);+ cachedPackageVersion = "unknown";+ return "unknown";+ }+}+async function fetchGitHubVersion() {try {+ const packageVersion = getPackageVersion();+// Get latest commit from configured branchconst response = await fetch(`https://api.github.com/repos/${GITHUB_REPO_OWNER}/${GITHUB_REPO_NAME}/commits/${GITHUB_BRANCH}`,@@ -47,7 +71,7 @@ async function fetchGitHubVersion() {const branch = GITHUB_BRANCH;return {- version: `${branch}-${commitHash}`,+ version: packageVersion,branch,commitHash,buildDate: data.commit.committer.date,@@ -98,9 +122,10 @@ export async function GET() {}// Fallback to dev-local if GitHub API fails+ const packageVersion = getPackageVersion();return NextResponse.json({- version: "dev-local",+ version: packageVersion,branch: "unknown",commitHash: "unknown",buildDate: new Date().toISOString(),diff --git a/package.json b/package.jsonindex 6f0c8c1..1deb3a5 100644--- a/package.json+++ b/package.json@@ -10,7 +10,10 @@"db:generate": "drizzle-kit generate","db:migrate": "drizzle-kit migrate","db:studio": "drizzle-kit studio",- "db:push": "drizzle-kit push"+ "db:push": "drizzle-kit push",+ "release:patch": "npm version patch && git push && git push --tags",+ "release:minor": "npm version minor && git push && git push --tags",+ "release:major": "npm version major && git push && git push --tags"},"dependencies": {"@radix-ui/react-checkbox": "^1.3.3",