Skip to content

armgit / memos

Public Imported from GitHub
0

Memos is an open-source, self-hosted note-taking app that brings your everyday thoughts together in a personal timeline. Your data stays yours, and you choose what to keep private or share.

refactor: improve GitHub Actions workflows structure and maintainability

Steven7465fbb4cc12
diff --git a/.github/workflows/backend-tests.yml b/.github/workflows/backend-tests.yml
index 4ba0fb980..c1b1b8909 100644
--- a/.github/workflows/backend-tests.yml
+++ b/.github/workflows/backend-tests.yml
@@ -4,8 +4,7 @@ on:
push:
branches: [main]
pull_request:
- branches:
- - main
+ branches: [main]
paths:
- "go.mod"
- "go.sum"
@@ -15,55 +14,58 @@ concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true
+env:
+ GO_VERSION: "1.25"
+
jobs:
- go-static-checks:
+ static-checks:
+ name: Static Checks
runs-on: ubuntu-latest
steps:
- - uses: actions/checkout@v6
+ - name: Checkout code
+ uses: actions/checkout@v6
- - uses: actions/setup-go@v6
+ - name: Setup Go
+ uses: actions/setup-go@v6
with:
- go-version: 1.25
+ go-version: ${{ env.GO_VERSION }}
cache: true
cache-dependency-path: go.sum
- name: Verify go.mod is tidy
run: |
- go mod tidy -go=1.25
+ go mod tidy -go=${{ env.GO_VERSION }}
git diff --exit-code
- - name: golangci-lint
+ - name: Run golangci-lint
uses: golangci/golangci-lint-action@v9
with:
version: v2.4.0
args: --timeout=3m
- go-tests:
+ tests:
+ name: Tests (${{ matrix.test-group }})
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
- test-group:
- - store
- - server
- - plugin
- - other
+ test-group: [store, server, plugin, other]
steps:
- - uses: actions/checkout@v6
+ - name: Checkout code
+ uses: actions/checkout@v6
- - uses: actions/setup-go@v6
+ - name: Setup Go
+ uses: actions/setup-go@v6
with:
- go-version: 1.25
+ go-version: ${{ env.GO_VERSION }}
cache: true
cache-dependency-path: go.sum
- - name: Run tests - ${{ matrix.test-group }}
+ - name: Run tests
run: |
case "${{ matrix.test-group }}" in
store)
# Run store tests for all drivers (sqlite, mysql, postgres)
- # The TestMain in store/test runs all drivers when DRIVER is not set
- # Note: We run without -race for container tests due to testcontainers race issues
go test -v -coverprofile=coverage.out -covermode=atomic ./store/...
;;
server)
diff --git a/.github/workflows/build-binaries.yml b/.github/workflows/build-binaries.yml
index ccaf85ca4..0d35b8757 100644
--- a/.github/workflows/build-binaries.yml
+++ b/.github/workflows/build-binaries.yml
@@ -1,76 +1,137 @@
name: Build Binaries
+# Manually triggered workflow to build multi-platform binaries
+# Produces distributable packages for Linux, macOS, and Windows
on:
workflow_dispatch:
+# Environment variables for build configuration
+env:
+ GO_VERSION: "1.25"
+ NODE_VERSION: "22"
+ PNPM_VERSION: "10"
+ ARTIFACT_RETENTION_DAYS: 60
+
jobs:
+ # Job 1: Extract version information
+ # - For git tags: use tag version (e.g., v0.28.1 -> 0.28.1)
+ # - For branches: use branch-name-shortSHA format
+ prepare:
+ name: Extract Version
+ runs-on: ubuntu-latest
+ outputs:
+ version: ${{ steps.version.outputs.version }}
+ steps:
+ - name: Checkout code
+ uses: actions/checkout@v6
+ with:
+ fetch-depth: 0 # Full history for git describe
+
+ - name: Extract version
+ id: version
+ run: |
+ # Try to get version from git tag
+ TAG=$(git describe --tags --exact-match 2>/dev/null || echo "")
+ if [ -n "$TAG" ]; then
+ echo "version=${TAG#v}" >> $GITHUB_OUTPUT
+ echo "Version from tag: ${TAG#v}"
+ else
+ # Use branch name + short SHA
+ BRANCH="${GITHUB_REF_NAME//\//-}"
+ SHORT_SHA="${GITHUB_SHA:0:7}"
+ echo "version=${BRANCH}-${SHORT_SHA}" >> $GITHUB_OUTPUT
+ echo "Version from branch: ${BRANCH}-${SHORT_SHA}"
+ fi
+
+ # Job 2: Build frontend assets
+ # - Builds React frontend with Vite
+ # - Produces static files that will be embedded in Go binary
+ # - Shared across all platform builds
build-frontend:
+ name: Build Frontend
+ needs: prepare
runs-on: ubuntu-latest
steps:
- - uses: actions/checkout@v6
+ - name: Checkout code
+ uses: actions/checkout@v6
- - uses: pnpm/[email protected]
+ - name: Setup pnpm
+ uses: pnpm/[email protected]
with:
- version: 10
- - uses: actions/setup-node@v6
+ version: ${{ env.PNPM_VERSION }}
+
+ - name: Setup Node.js
+ uses: actions/setup-node@v6
with:
- node-version: "22"
+ node-version: ${{ env.NODE_VERSION }}
cache: pnpm
- cache-dependency-path: "web/pnpm-lock.yaml"
+ cache-dependency-path: web/pnpm-lock.yaml
+
- name: Get pnpm store directory
id: pnpm-cache
shell: bash
run: echo "STORE_PATH=$(pnpm store path)" >> $GITHUB_OUTPUT
+
- name: Setup pnpm cache
uses: actions/cache@v5
with:
path: ${{ steps.pnpm-cache.outputs.STORE_PATH }}
key: ${{ runner.os }}-pnpm-store-${{ hashFiles('web/pnpm-lock.yaml') }}
restore-keys: ${{ runner.os }}-pnpm-store-
- - run: pnpm install --frozen-lockfile
+
+ - name: Install dependencies
working-directory: web
- - name: Run frontend build
- run: pnpm release
+ run: pnpm install --frozen-lockfile
+
+ - name: Build frontend
working-directory: web
+ run: pnpm release
- name: Upload frontend artifacts
uses: actions/upload-artifact@v6
with:
name: frontend-dist
path: server/router/frontend/dist
- retention-days: 7
+ retention-days: ${{ env.ARTIFACT_RETENTION_DAYS }}
+ # Job 3: Build Go binaries for multiple platforms
+ # - Cross-compiles using native Go toolchain
+ # - Embeds frontend assets built in previous job
+ # - Produces static binaries with no external dependencies
+ # - Packages as tar.gz (Unix) or zip (Windows)
build-binaries:
- needs: build-frontend
+ name: Build ${{ matrix.goos }}-${{ matrix.goarch }}${{ matrix.goarm && format('v{0}', matrix.goarm) || '' }}
+ needs: [prepare, build-frontend]
runs-on: ubuntu-latest
strategy:
+ fail-fast: false
matrix:
include:
+ # Linux targets
- goos: linux
goarch: amd64
- platform: linux/amd64
- goos: linux
goarch: arm64
- platform: linux/arm64
- goos: linux
goarch: arm
goarm: "7"
- platform: linux/arm/v7
+ # macOS targets
- goos: darwin
- goarch: amd64
- platform: darwin/amd64
+ goarch: amd64 # Intel Macs
- goos: darwin
- goarch: arm64
- platform: darwin/arm64
+ goarch: arm64 # Apple Silicon
+ # Windows targets
- goos: windows
goarch: amd64
- platform: windows/amd64
+
steps:
- - uses: actions/checkout@v6
+ - name: Checkout code
+ uses: actions/checkout@v6
- - uses: actions/setup-go@v6
+ - name: Setup Go
+ uses: actions/setup-go@v6
with:
- go-version: "1.25"
+ go-version: ${{ env.GO_VERSION }}
cache: true
- name: Download frontend artifacts
@@ -86,13 +147,15 @@ jobs:
GOARM: ${{ matrix.goarm }}
CGO_ENABLED: "0"
run: |
- # Determine output file name
+ # Determine output binary name
OUTPUT_NAME="memos"
- if [ "${{ matrix.goos }}" = "windows" ]; then
+ if [ "$GOOS" = "windows" ]; then
OUTPUT_NAME="memos.exe"
fi
- # Build with optimizations
+ mkdir -p build
+
+ # Build static binary with optimizations
go build \
-trimpath \
-ldflags="-s -w -extldflags '-static'" \
@@ -100,69 +163,99 @@ jobs:
-o "build/${OUTPUT_NAME}" \
./cmd/memos
- echo "Built: build/${OUTPUT_NAME}"
+ echo "✓ Built: build/${OUTPUT_NAME}"
ls -lh build/
- name: Package binary
+ id: package
+ env:
+ VERSION: ${{ needs.prepare.outputs.version }}
+ GOOS: ${{ matrix.goos }}
+ GOARCH: ${{ matrix.goarch }}
+ GOARM: ${{ matrix.goarm }}
run: |
cd build
- # Create package name
- PACKAGE_NAME="memos-${{ matrix.goos }}-${{ matrix.goarch }}"
- if [ -n "${{ matrix.goarm }}" ]; then
- PACKAGE_NAME="memos-${{ matrix.goos }}-${{ matrix.goarch }}v${{ matrix.goarm }}"
+ # Construct package name: memos-{version}-{os}-{arch}[v{arm_version}]
+ PACKAGE_NAME="memos-${VERSION}-${GOOS}-${GOARCH}"
+ if [ -n "$GOARM" ]; then
+ PACKAGE_NAME="${PACKAGE_NAME}v${GOARM}"
fi
- # Package based on OS
- if [ "${{ matrix.goos }}" = "windows" ]; then
- zip "${PACKAGE_NAME}.zip" memos.exe
- echo "ARTIFACT_NAME=${PACKAGE_NAME}.zip" >> $GITHUB_ENV
+ # Package based on platform
+ if [ "$GOOS" = "windows" ]; then
+ ARTIFACT_NAME="${PACKAGE_NAME}.zip"
+ zip -q "${ARTIFACT_NAME}" memos.exe
else
- tar czf "${PACKAGE_NAME}.tar.gz" memos
- echo "ARTIFACT_NAME=${PACKAGE_NAME}.tar.gz" >> $GITHUB_ENV
+ ARTIFACT_NAME="${PACKAGE_NAME}.tar.gz"
+ tar czf "${ARTIFACT_NAME}" memos
fi
- ls -lh
- echo "Package created: ${ARTIFACT_NAME}"
+ # Output for next step
+ echo "ARTIFACT_NAME=${ARTIFACT_NAME}" >> $GITHUB_ENV
+ echo "✓ Package created: ${ARTIFACT_NAME} ($(du -h "${ARTIFACT_NAME}" | cut -f1))"
- name: Upload binary artifact
uses: actions/upload-artifact@v6
with:
name: ${{ env.ARTIFACT_NAME }}
path: build/${{ env.ARTIFACT_NAME }}
- retention-days: 7
+ retention-days: ${{ env.ARTIFACT_RETENTION_DAYS }}
+ # Job 4: Generate build summary
+ # - Downloads all built artifacts
+ # - Creates formatted summary table with sizes
+ # - Displayed in GitHub Actions UI
summary:
- needs: build-binaries
+ name: Generate Summary
+ needs: [prepare, build-binaries]
runs-on: ubuntu-latest
+ if: always()
steps:
- name: Download all artifacts
uses: actions/download-artifact@v7
with:
path: artifacts
pattern: memos-*
+ merge-multiple: false
- name: Generate build summary
+ env:
+ VERSION: ${{ needs.prepare.outputs.version }}
run: |
- echo "## Build Summary" >> $GITHUB_STEP_SUMMARY
- echo "" >> $GITHUB_STEP_SUMMARY
- echo "**Branch:** \`${{ github.ref_name }}\`" >> $GITHUB_STEP_SUMMARY
- echo "**Commit:** \`${{ github.sha }}\`" >> $GITHUB_STEP_SUMMARY
- echo "" >> $GITHUB_STEP_SUMMARY
- echo "### Built Artifacts" >> $GITHUB_STEP_SUMMARY
- echo "" >> $GITHUB_STEP_SUMMARY
- echo "| Platform | Artifact | Size |" >> $GITHUB_STEP_SUMMARY
- echo "|----------|----------|------|" >> $GITHUB_STEP_SUMMARY
+ {
+ echo "## 🎉 Build Complete"
+ echo ""
+ echo "### Build Information"
+ echo "| Key | Value |"
+ echo "|-----|-------|"
+ echo "| **Version** | \`${VERSION}\` |"
+ echo "| **Branch** | \`${{ github.ref_name }}\` |"
+ echo "| **Commit** | \`${{ github.sha }}\` |"
+ echo "| **Triggered by** | @${{ github.actor }} |"
+ echo ""
+ echo "### 📦 Built Artifacts"
+ echo ""
+ echo "| Platform | Artifact | Size |"
+ echo "|----------|----------|------|"
+ } >> $GITHUB_STEP_SUMMARY
+ # List all artifacts with sizes
cd artifacts
for dir in */; do
- artifact=$(ls "$dir" 2>/dev/null | head -1)
- if [ -n "$artifact" ]; then
- size=$(du -h "$dir/$artifact" | cut -f1)
- platform=$(echo "$artifact" | sed 's/memos-//;s/\.(tar\.gz|zip)$//')
- echo "| \`$platform\` | \`$artifact\` | $size |" >> $GITHUB_STEP_SUMMARY
+ if [ -d "$dir" ]; then
+ artifact=$(ls "$dir" 2>/dev/null | head -1)
+ if [ -n "$artifact" ]; then
+ size=$(du -h "$dir/$artifact" | cut -f1)
+ # Extract platform from filename (remove memos-version- prefix and extension)
+ platform=$(echo "$artifact" | sed "s/memos-${VERSION}-//;s/\.(tar\.gz|zip)$//")
+ echo "| \`$platform\` | \`$artifact\` | **$size** |" >> $GITHUB_STEP_SUMMARY
+ fi
fi
done
- echo "" >> $GITHUB_STEP_SUMMARY
- echo "**Download:** Go to the workflow run summary to download artifacts." >> $GITHUB_STEP_SUMMARY
+ {
+ echo ""
+ echo "### 📥 Download"
+ echo "Artifacts are available in the **Artifacts** section above (retention: ${{ env.ARTIFACT_RETENTION_DAYS }} days)."
+ } >> $GITHUB_STEP_SUMMARY
diff --git a/.github/workflows/build-and-push-canary-image.yml b/.github/workflows/build-canary-image.yml
similarity index 99%
rename from .github/workflows/build-and-push-canary-image.yml
rename to .github/workflows/build-canary-image.yml
index 1b8c0b980..16f6ab337 100644
--- a/.github/workflows/build-and-push-canary-image.yml
+++ b/.github/workflows/build-canary-image.yml
@@ -1,4 +1,4 @@
-name: Build and Push Canary Image
+name: Build Canary Image
on:
push:
diff --git a/.github/workflows/build-and-push-stable-image.yml b/.github/workflows/build-stable-image.yml
similarity index 99%
rename from .github/workflows/build-and-push-stable-image.yml
rename to .github/workflows/build-stable-image.yml
index db6ad0556..4ec106bcf 100644
--- a/.github/workflows/build-and-push-stable-image.yml
+++ b/.github/workflows/build-stable-image.yml
@@ -1,4 +1,4 @@
-name: Build and Push Stable Image
+name: Build Stable Image
on:
push:
diff --git a/.github/workflows/demo-render-deploy.yml b/.github/workflows/demo-deploy.yml
similarity index 94%
rename from .github/workflows/demo-render-deploy.yml
rename to .github/workflows/demo-deploy.yml
index 442779911..4ff6a3742 100644
--- a/.github/workflows/demo-render-deploy.yml
+++ b/.github/workflows/demo-deploy.yml
@@ -1,4 +1,4 @@
-name: Demo Render Deploy
+name: Demo Deploy
on:
workflow_dispatch:
diff --git a/.github/workflows/frontend-tests.yml b/.github/workflows/frontend-tests.yml
index 04e807949..c296f5eba 100644
--- a/.github/workflows/frontend-tests.yml
+++ b/.github/workflows/frontend-tests.yml
@@ -4,44 +4,69 @@ on:
push:
branches: [main]
pull_request:
- branches:
- - main
+ branches: [main]
paths:
- "web/**"
+concurrency:
+ group: ${{ github.workflow }}-${{ github.ref }}
+ cancel-in-progress: true
+
+env:
+ NODE_VERSION: "22"
+ PNPM_VERSION: "10"
+
jobs:
- static-checks:
+ lint:
+ name: Lint
runs-on: ubuntu-latest
steps:
- - uses: actions/checkout@v6
- - uses: pnpm/[email protected]
+ - name: Checkout code
+ uses: actions/checkout@v6
+
+ - name: Setup pnpm
+ uses: pnpm/[email protected]
with:
- version: 9
- - uses: actions/setup-node@v6
+ version: ${{ env.PNPM_VERSION }}
+
+ - name: Setup Node.js
+ uses: actions/setup-node@v6
with:
- node-version: "20"
+ node-version: ${{ env.NODE_VERSION }}
cache: pnpm
- cache-dependency-path: "web/pnpm-lock.yaml"
- - run: pnpm install
+ cache-dependency-path: web/pnpm-lock.yaml
+
+ - name: Install dependencies
working-directory: web
- - name: Run check
- run: pnpm lint
+ run: pnpm install --frozen-lockfile
+
+ - name: Run lint
working-directory: web
+ run: pnpm lint
- frontend-build:
+ build:
+ name: Build
runs-on: ubuntu-latest
steps:
- - uses: actions/checkout@v6
- - uses: pnpm/[email protected]
+ - name: Checkout code
+ uses: actions/checkout@v6
+
+ - name: Setup pnpm
+ uses: pnpm/[email protected]
with:
- version: 9
- - uses: actions/setup-node@v6
+ version: ${{ env.PNPM_VERSION }}
+
+ - name: Setup Node.js
+ uses: actions/setup-node@v6
with:
- node-version: "20"
+ node-version: ${{ env.NODE_VERSION }}
cache: pnpm
- cache-dependency-path: "web/pnpm-lock.yaml"
- - run: pnpm install
+ cache-dependency-path: web/pnpm-lock.yaml
+
+ - name: Install dependencies
working-directory: web
- - name: Run frontend build
- run: pnpm build
+ run: pnpm install --frozen-lockfile
+
+ - name: Build frontend
working-directory: web
+ run: pnpm build
diff --git a/.github/workflows/proto-linter.yml b/.github/workflows/proto-linter.yml
index 0bb8e977e..a6422349c 100644
--- a/.github/workflows/proto-linter.yml
+++ b/.github/workflows/proto-linter.yml
@@ -4,30 +4,37 @@ on:
push:
branches: [main]
pull_request:
- branches:
- - main
+ branches: [main]
paths:
- "proto/**"
+concurrency:
+ group: ${{ github.workflow }}-${{ github.ref }}
+ cancel-in-progress: true
+
jobs:
- lint-protos:
+ lint:
+ name: Lint Protos
runs-on: ubuntu-latest
steps:
- - name: Checkout
+ - name: Checkout code
uses: actions/checkout@v6
with:
fetch-depth: 0
+
- name: Setup buf
uses: bufbuild/buf-setup-action@v1
with:
github_token: ${{ github.token }}
- - name: buf lint
+
+ - name: Run buf lint
uses: bufbuild/buf-lint-action@v1
with:
- input: "proto"
- - name: buf format
+ input: proto
+
+ - name: Check buf format
run: |
if [[ $(buf format -d) ]]; then
- echo "Run 'buf format -d'"
+ echo "❌ Proto files are not formatted. Run 'buf format -w' to fix."
exit 1
fi
diff --git a/.github/workflows/stale.yml b/.github/workflows/stale.yml
index ad330a6f7..761d3f2fe 100644
--- a/.github/workflows/stale.yml
+++ b/.github/workflows/stale.yml
@@ -1,17 +1,18 @@
-name: Stale
+name: Stale Issues
on:
schedule:
- - cron: "0 */8 * * *"
+ - cron: "0 */8 * * *" # Every 8 hours
jobs:
- stale:
+ close-stale:
+ name: Close Stale Issues
runs-on: ubuntu-latest
permissions:
issues: write
-
steps:
- - uses: actions/[email protected]
+ - name: Close stale issues
+ uses: actions/[email protected]
with:
days-before-issue-stale: 14
days-before-issue-close: 7