Compare commits
15 Commits
todo/mvp0-
...
todo/mvp0-
| Author | SHA1 | Date | |
|---|---|---|---|
|
f9f2b4eb15
|
|||
|
ccac669454
|
|||
|
af52b8581f
|
|||
|
3de4d5732e
|
|||
|
14c3df623a
|
|||
|
a57464d818
|
|||
|
c174f840bc
|
|||
|
334a5e3526
|
|||
|
516b773012
|
|||
|
21cc55a1b9
|
|||
|
969e88670f
|
|||
|
cec87679ca
|
|||
|
4d6e17a13b
|
|||
|
7b4b23fc4f
|
|||
|
5872593b01
|
@@ -10,5 +10,7 @@ CMS_SUPPORT_EMAIL="support@cms.local"
|
||||
CMS_SUPPORT_PASSWORD="change-me-support-password"
|
||||
CMS_SUPPORT_NAME="Technical Support"
|
||||
CMS_SUPPORT_LOGIN_KEY="support-access-change-me"
|
||||
NEXT_PUBLIC_APP_VERSION="0.1.0-dev"
|
||||
NEXT_PUBLIC_GIT_SHA="local"
|
||||
# Optional dev bypass role for admin middleware. Leave empty to require auth login.
|
||||
# CMS_DEV_ROLE="admin"
|
||||
|
||||
4
.env.gitea-runner.example
Normal file
4
.env.gitea-runner.example
Normal file
@@ -0,0 +1,4 @@
|
||||
GITEA_INSTANCE_URL="https://git.example.com"
|
||||
GITEA_RUNNER_REGISTRATION_TOKEN="replace-with-runner-registration-token"
|
||||
GITEA_RUNNER_NAME="cms-runner"
|
||||
GITEA_RUNNER_LABELS="ubuntu-latest:docker://node:20-bookworm"
|
||||
17
.gitea/PULL_REQUEST_TEMPLATE.md
Normal file
17
.gitea/PULL_REQUEST_TEMPLATE.md
Normal file
@@ -0,0 +1,17 @@
|
||||
## Summary
|
||||
|
||||
- TODO item reference (exact text): `...`
|
||||
- Scope (single primary TODO item): `...`
|
||||
|
||||
## Checklist
|
||||
|
||||
- [ ] Linked TODO item is in `TODO.md`
|
||||
- [ ] Branch name follows `todo/*`, `refactor/*`, or `code/*`
|
||||
- [ ] `bun run check`
|
||||
- [ ] `bun run typecheck`
|
||||
- [ ] `bun run test`
|
||||
- [ ] E2E validation plan included (`bun run test:e2e` or reason if deferred)
|
||||
|
||||
## Notes
|
||||
|
||||
- Risks / migrations / rollout notes:
|
||||
25
.gitea/scripts/check-branch-name.sh
Executable file
25
.gitea/scripts/check-branch-name.sh
Executable file
@@ -0,0 +1,25 @@
|
||||
#!/usr/bin/env sh
|
||||
set -eu
|
||||
|
||||
branch="${1:-}"
|
||||
|
||||
if [ -z "$branch" ]; then
|
||||
echo "Missing branch name."
|
||||
exit 1
|
||||
fi
|
||||
|
||||
case "$branch" in
|
||||
dev|staging|main)
|
||||
echo "Long-lived branch detected: $branch"
|
||||
exit 0
|
||||
;;
|
||||
esac
|
||||
|
||||
if printf "%s" "$branch" | grep -Eq '^(todo|refactor|code)\/[a-z0-9]+([._-][a-z0-9]+)*$'; then
|
||||
echo "Branch naming valid: $branch"
|
||||
exit 0
|
||||
fi
|
||||
|
||||
echo "Invalid branch name: $branch"
|
||||
echo "Expected: todo/<slug> | refactor/<slug> | code/<slug>"
|
||||
exit 1
|
||||
17
.gitea/scripts/check-pr-todo-reference.sh
Executable file
17
.gitea/scripts/check-pr-todo-reference.sh
Executable file
@@ -0,0 +1,17 @@
|
||||
#!/usr/bin/env sh
|
||||
set -eu
|
||||
|
||||
body="${1:-}"
|
||||
|
||||
if [ -z "$body" ]; then
|
||||
echo "PR body is empty."
|
||||
exit 1
|
||||
fi
|
||||
|
||||
if printf "%s" "$body" | grep -Eq 'TODO|todo|\[P[1-3]\]'; then
|
||||
echo "PR body includes TODO reference."
|
||||
exit 0
|
||||
fi
|
||||
|
||||
echo "PR body must reference the related TODO item."
|
||||
exit 1
|
||||
34
.gitea/scripts/configure-branch-protection.sh
Executable file
34
.gitea/scripts/configure-branch-protection.sh
Executable file
@@ -0,0 +1,34 @@
|
||||
#!/usr/bin/env sh
|
||||
set -eu
|
||||
|
||||
if [ "${#}" -ne 4 ]; then
|
||||
echo "Usage: $0 <base-url> <owner> <repo> <token>"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
base_url="$1"
|
||||
owner="$2"
|
||||
repo="$3"
|
||||
token="$4"
|
||||
|
||||
protect_branch() {
|
||||
branch="$1"
|
||||
|
||||
curl -sS -X POST \
|
||||
"${base_url}/api/v1/repos/${owner}/${repo}/branch_protections" \
|
||||
-H "Authorization: token ${token}" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d "{
|
||||
\"branch_name\": \"${branch}\",
|
||||
\"enable_push\": false,
|
||||
\"enable_push_whitelist\": false,
|
||||
\"enable_merge_whitelist\": false,
|
||||
\"enable_status_check\": true,
|
||||
\"status_check_contexts\": [\"Governance Checks\", \"Lint Typecheck Unit E2E\"]
|
||||
}" >/dev/null
|
||||
}
|
||||
|
||||
protect_branch "main"
|
||||
protect_branch "staging"
|
||||
|
||||
echo "Branch protection applied for main and staging."
|
||||
45
.gitea/scripts/extract-release-notes.sh
Normal file
45
.gitea/scripts/extract-release-notes.sh
Normal file
@@ -0,0 +1,45 @@
|
||||
#!/usr/bin/env sh
|
||||
set -eu
|
||||
|
||||
tag="${1:-}"
|
||||
|
||||
if [ -z "$tag" ]; then
|
||||
echo "Missing release tag argument (expected vX.Y.Z)."
|
||||
exit 1
|
||||
fi
|
||||
|
||||
if [ ! -f CHANGELOG.md ]; then
|
||||
echo "CHANGELOG.md not found."
|
||||
exit 1
|
||||
fi
|
||||
|
||||
version="${tag#v}"
|
||||
|
||||
awk -v version="$version" '
|
||||
BEGIN {
|
||||
in_section = 0
|
||||
started = 0
|
||||
}
|
||||
/^## / {
|
||||
if (in_section == 1) {
|
||||
exit
|
||||
}
|
||||
|
||||
if (index($0, version) > 0) {
|
||||
in_section = 1
|
||||
started = 1
|
||||
print $0
|
||||
next
|
||||
}
|
||||
}
|
||||
{
|
||||
if (in_section == 1) {
|
||||
print $0
|
||||
}
|
||||
}
|
||||
END {
|
||||
if (started == 0) {
|
||||
exit 2
|
||||
}
|
||||
}
|
||||
' CHANGELOG.md
|
||||
80
.gitea/scripts/publish-gitea-release.mjs
Normal file
80
.gitea/scripts/publish-gitea-release.mjs
Normal file
@@ -0,0 +1,80 @@
|
||||
import { readFileSync } from "node:fs"
|
||||
|
||||
const tag = process.env.RELEASE_TAG?.trim()
|
||||
const releaseName = process.env.RELEASE_NAME?.trim() || tag
|
||||
const bodyFile = process.env.RELEASE_BODY_FILE?.trim() || ".gitea-release-notes.md"
|
||||
const serverUrl = process.env.GITHUB_SERVER_URL?.trim()
|
||||
const repository = process.env.GITHUB_REPOSITORY?.trim()
|
||||
const token = process.env.GITEA_RELEASE_TOKEN?.trim()
|
||||
|
||||
if (!tag) {
|
||||
throw new Error("RELEASE_TAG is required")
|
||||
}
|
||||
|
||||
if (!serverUrl || !repository) {
|
||||
throw new Error("GITHUB_SERVER_URL and GITHUB_REPOSITORY are required")
|
||||
}
|
||||
|
||||
if (!token) {
|
||||
throw new Error("GITEA_RELEASE_TOKEN is required")
|
||||
}
|
||||
|
||||
const body = readFileSync(bodyFile, "utf8")
|
||||
const baseApi = `${serverUrl.replace(/\/$/, "")}/api/v1/repos/${repository}`
|
||||
|
||||
async function request(path, options = {}) {
|
||||
const response = await fetch(`${baseApi}${path}`, {
|
||||
...options,
|
||||
headers: {
|
||||
"content-type": "application/json",
|
||||
authorization: `token ${token}`,
|
||||
...(options.headers ?? {}),
|
||||
},
|
||||
})
|
||||
|
||||
return response
|
||||
}
|
||||
|
||||
const payload = {
|
||||
tag_name: tag,
|
||||
target_commitish: "main",
|
||||
name: releaseName,
|
||||
body,
|
||||
draft: false,
|
||||
prerelease: false,
|
||||
}
|
||||
|
||||
const existingResponse = await request(`/releases/tags/${encodeURIComponent(tag)}`)
|
||||
|
||||
if (existingResponse.ok) {
|
||||
const existing = await existingResponse.json()
|
||||
const updateResponse = await request(`/releases/${existing.id}`, {
|
||||
method: "PATCH",
|
||||
body: JSON.stringify({
|
||||
...payload,
|
||||
target_commitish: existing.target_commitish ?? payload.target_commitish,
|
||||
}),
|
||||
})
|
||||
|
||||
if (!updateResponse.ok) {
|
||||
const message = await updateResponse.text()
|
||||
throw new Error(`Failed to update release: ${updateResponse.status} ${message}`)
|
||||
}
|
||||
|
||||
console.log(`Updated release for tag ${tag}`)
|
||||
} else if (existingResponse.status === 404) {
|
||||
const createResponse = await request("/releases", {
|
||||
method: "POST",
|
||||
body: JSON.stringify(payload),
|
||||
})
|
||||
|
||||
if (!createResponse.ok) {
|
||||
const message = await createResponse.text()
|
||||
throw new Error(`Failed to create release: ${createResponse.status} ${message}`)
|
||||
}
|
||||
|
||||
console.log(`Created release for tag ${tag}`)
|
||||
} else {
|
||||
const message = await existingResponse.text()
|
||||
throw new Error(`Failed to query existing release: ${existingResponse.status} ${message}`)
|
||||
}
|
||||
18
.gitea/scripts/validate-tag-version.sh
Executable file
18
.gitea/scripts/validate-tag-version.sh
Executable file
@@ -0,0 +1,18 @@
|
||||
#!/usr/bin/env sh
|
||||
set -eu
|
||||
|
||||
tag="${1:-}"
|
||||
|
||||
if [ -z "$tag" ]; then
|
||||
echo "Missing tag ref name (expected vX.Y.Z)."
|
||||
exit 1
|
||||
fi
|
||||
|
||||
version="$(node -p "require('./package.json').version")"
|
||||
|
||||
if [ "$tag" != "v$version" ]; then
|
||||
echo "Tag/version mismatch: tag=$tag package.json=$version"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
echo "Tag matches package.json version: $tag"
|
||||
@@ -1,113 +0,0 @@
|
||||
name: CMS CI/CD (Theoretical)
|
||||
|
||||
on:
|
||||
pull_request:
|
||||
push:
|
||||
branches:
|
||||
- dev
|
||||
- main
|
||||
- staging
|
||||
tags:
|
||||
- "v*"
|
||||
workflow_dispatch:
|
||||
|
||||
env:
|
||||
BUN_VERSION: "1.3.5"
|
||||
|
||||
jobs:
|
||||
quality:
|
||||
name: Lint Typecheck Tests
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Setup Bun
|
||||
uses: oven-sh/setup-bun@v2
|
||||
with:
|
||||
bun-version: ${{ env.BUN_VERSION }}
|
||||
|
||||
- name: Install dependencies
|
||||
run: bun install --frozen-lockfile
|
||||
|
||||
- name: Generate Prisma client
|
||||
run: bun run db:generate
|
||||
|
||||
- name: Lint
|
||||
run: bun run lint
|
||||
|
||||
- name: Typecheck
|
||||
run: bun run typecheck
|
||||
|
||||
- name: Unit and component tests
|
||||
run: bun run test
|
||||
|
||||
- name: E2E suite discovery check
|
||||
run: bun run test:e2e --list
|
||||
|
||||
- name: Conventional commit check (latest commit)
|
||||
run: bun run commitlint
|
||||
|
||||
build_staging_images:
|
||||
name: Build Staging Images
|
||||
runs-on: ubuntu-latest
|
||||
needs: quality
|
||||
if: github.ref == 'refs/heads/staging'
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Build web image (staging)
|
||||
run: docker build -f apps/web/Dockerfile -t cms-web:staging .
|
||||
|
||||
- name: Build admin image (staging)
|
||||
run: docker build -f apps/admin/Dockerfile -t cms-admin:staging .
|
||||
|
||||
build_production_images:
|
||||
name: Build Production Images
|
||||
runs-on: ubuntu-latest
|
||||
needs: quality
|
||||
if: startsWith(github.ref, 'refs/tags/v')
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Build web image (production)
|
||||
run: docker build -f apps/web/Dockerfile -t cms-web:${{ github.ref_name }} .
|
||||
|
||||
- name: Build admin image (production)
|
||||
run: docker build -f apps/admin/Dockerfile -t cms-admin:${{ github.ref_name }} .
|
||||
|
||||
- name: Generate changelog
|
||||
run: |
|
||||
bun install --frozen-lockfile
|
||||
bun run changelog:release
|
||||
|
||||
- name: Push images (placeholder)
|
||||
run: |
|
||||
echo "TODO: docker login to registry"
|
||||
echo "TODO: docker push cms-web:${{ github.ref_name }}"
|
||||
echo "TODO: docker push cms-admin:${{ github.ref_name }}"
|
||||
echo "TODO: publish CHANGELOG.md content as release notes"
|
||||
|
||||
deploy_staging:
|
||||
name: Deploy Staging (Placeholder)
|
||||
runs-on: ubuntu-latest
|
||||
needs: build_staging_images
|
||||
if: github.ref == 'refs/heads/staging'
|
||||
steps:
|
||||
- name: Deploy placeholder
|
||||
run: |
|
||||
echo "TODO: Pull and restart staging compose on target host"
|
||||
echo "docker compose -f docker-compose.staging.yml up -d"
|
||||
|
||||
deploy_production:
|
||||
name: Deploy Production (Placeholder)
|
||||
runs-on: ubuntu-latest
|
||||
needs: build_production_images
|
||||
if: startsWith(github.ref, 'refs/tags/v')
|
||||
steps:
|
||||
- name: Deploy placeholder
|
||||
run: |
|
||||
echo "TODO: Pull and restart production compose on target host"
|
||||
echo "docker compose -f docker-compose.production.yml up -d"
|
||||
@@ -25,9 +25,39 @@ env:
|
||||
CMS_SUPPORT_LOGIN_KEY: "support-access"
|
||||
|
||||
jobs:
|
||||
governance:
|
||||
name: Governance Checks
|
||||
runs-on: node22-bun
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Validate branch naming
|
||||
run: |
|
||||
branch="${GITHUB_HEAD_REF:-${GITHUB_REF_NAME}}"
|
||||
sh .gitea/scripts/check-branch-name.sh "$branch"
|
||||
|
||||
- name: Validate PR TODO reference
|
||||
if: github.event_name == 'pull_request'
|
||||
run: |
|
||||
body='${{ github.event.pull_request.body }}'
|
||||
sh .gitea/scripts/check-pr-todo-reference.sh "$body"
|
||||
|
||||
- name: Commit schema check (latest commit)
|
||||
uses: oven-sh/setup-bun@v2
|
||||
with:
|
||||
bun-version: ${{ env.BUN_VERSION }}
|
||||
|
||||
- name: Install dependencies for commitlint
|
||||
run: bun install --frozen-lockfile
|
||||
|
||||
- name: Commitlint
|
||||
run: bun run commitlint
|
||||
|
||||
quality:
|
||||
name: Lint Typecheck Unit E2E
|
||||
runs-on: ubuntu-latest
|
||||
needs: governance
|
||||
runs-on: node22-bun
|
||||
services:
|
||||
postgres:
|
||||
image: postgres:16-alpine
|
||||
@@ -54,12 +84,21 @@ jobs:
|
||||
- name: Install dependencies
|
||||
run: bun install --frozen-lockfile
|
||||
|
||||
- name: Resolve build metadata
|
||||
run: |
|
||||
version=$(bun -e 'const pkg = JSON.parse(await Bun.file("package.json").text()); console.log(pkg.version)')
|
||||
echo "NEXT_PUBLIC_APP_VERSION=$version" >> "$GITHUB_ENV"
|
||||
echo "NEXT_PUBLIC_GIT_SHA=${GITHUB_SHA}" >> "$GITHUB_ENV"
|
||||
|
||||
- name: Install Playwright browser deps
|
||||
run: bunx playwright install --with-deps chromium
|
||||
|
||||
- name: Lint and format checks
|
||||
run: bun run check
|
||||
|
||||
- name: Generate Prisma client
|
||||
run: bun run db:generate
|
||||
|
||||
- name: Typecheck
|
||||
run: bun run typecheck
|
||||
|
||||
|
||||
54
.gitea/workflows/deploy.yml
Normal file
54
.gitea/workflows/deploy.yml
Normal file
@@ -0,0 +1,54 @@
|
||||
name: CMS Deploy
|
||||
|
||||
on:
|
||||
workflow_dispatch:
|
||||
inputs:
|
||||
environment:
|
||||
description: "Target environment"
|
||||
required: true
|
||||
type: choice
|
||||
options:
|
||||
- staging
|
||||
- production
|
||||
image_tag:
|
||||
description: "Image tag to deploy (e.g. v0.1.0)"
|
||||
required: true
|
||||
rollback_tag:
|
||||
description: "Optional rollback tag"
|
||||
required: false
|
||||
|
||||
jobs:
|
||||
deploy:
|
||||
name: Deploy Compose Stack
|
||||
runs-on: node22-bun
|
||||
steps:
|
||||
- name: Resolve deployment target
|
||||
id: target
|
||||
run: |
|
||||
if [ "${{ github.event.inputs.environment }}" = "staging" ]; then
|
||||
echo "host=${{ secrets.CMS_STAGING_HOST }}" >> "$GITHUB_OUTPUT"
|
||||
echo "user=${{ secrets.CMS_STAGING_USER }}" >> "$GITHUB_OUTPUT"
|
||||
echo "compose=docker-compose.staging.yml" >> "$GITHUB_OUTPUT"
|
||||
else
|
||||
echo "host=${{ secrets.CMS_PRODUCTION_HOST }}" >> "$GITHUB_OUTPUT"
|
||||
echo "user=${{ secrets.CMS_PRODUCTION_USER }}" >> "$GITHUB_OUTPUT"
|
||||
echo "compose=docker-compose.production.yml" >> "$GITHUB_OUTPUT"
|
||||
fi
|
||||
|
||||
- name: Setup SSH
|
||||
run: |
|
||||
mkdir -p ~/.ssh
|
||||
echo "${{ secrets.CMS_DEPLOY_KEY }}" > ~/.ssh/id_rsa
|
||||
chmod 600 ~/.ssh/id_rsa
|
||||
ssh-keyscan -H "${{ steps.target.outputs.host }}" >> ~/.ssh/known_hosts
|
||||
|
||||
- name: Deploy image tag
|
||||
run: |
|
||||
ssh "${{ steps.target.outputs.user }}@${{ steps.target.outputs.host }}" \
|
||||
"cd ${{ secrets.CMS_REMOTE_DEPLOY_PATH }} && CMS_IMAGE_TAG=${{ github.event.inputs.image_tag }} docker compose -f ${{ steps.target.outputs.compose }} up -d"
|
||||
|
||||
- name: Optional rollback
|
||||
if: github.event.inputs.rollback_tag != ''
|
||||
run: |
|
||||
ssh "${{ steps.target.outputs.user }}@${{ steps.target.outputs.host }}" \
|
||||
"cd ${{ secrets.CMS_REMOTE_DEPLOY_PATH }} && CMS_IMAGE_TAG=${{ github.event.inputs.rollback_tag }} docker compose -f ${{ steps.target.outputs.compose }} up -d"
|
||||
103
.gitea/workflows/release.yml
Normal file
103
.gitea/workflows/release.yml
Normal file
@@ -0,0 +1,103 @@
|
||||
name: CMS Release
|
||||
|
||||
on:
|
||||
push:
|
||||
tags:
|
||||
- "v*"
|
||||
workflow_dispatch:
|
||||
inputs:
|
||||
release_tag:
|
||||
description: "Release tag in vX.Y.Z format"
|
||||
required: false
|
||||
rollback_image_tag:
|
||||
description: "Optional rollback image tag"
|
||||
required: false
|
||||
|
||||
env:
|
||||
BUN_VERSION: "1.3.5"
|
||||
REGISTRY: ${{ secrets.CMS_IMAGE_REGISTRY }}
|
||||
IMAGE_NAMESPACE: ${{ secrets.CMS_IMAGE_NAMESPACE }}
|
||||
|
||||
jobs:
|
||||
release:
|
||||
name: Build Push Changelog
|
||||
if: github.event_name == 'push' || github.event.inputs.rollback_image_tag == ''
|
||||
runs-on: node22-bun
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Setup Bun
|
||||
uses: oven-sh/setup-bun@v2
|
||||
with:
|
||||
bun-version: ${{ env.BUN_VERSION }}
|
||||
|
||||
- name: Install dependencies
|
||||
run: bun install --frozen-lockfile
|
||||
|
||||
- name: Resolve release tag
|
||||
id: tag
|
||||
run: |
|
||||
if [ "${GITHUB_EVENT_NAME}" = "workflow_dispatch" ]; then
|
||||
if [ -z "${{ github.event.inputs.release_tag }}" ]; then
|
||||
echo "release_tag input is required when publishing a release manually."
|
||||
exit 1
|
||||
fi
|
||||
echo "value=${{ github.event.inputs.release_tag }}" >> "$GITHUB_OUTPUT"
|
||||
else
|
||||
echo "value=${GITHUB_REF_NAME}" >> "$GITHUB_OUTPUT"
|
||||
fi
|
||||
|
||||
- name: Validate tag against package version
|
||||
run: sh .gitea/scripts/validate-tag-version.sh "${{ steps.tag.outputs.value }}"
|
||||
|
||||
- name: Generate changelog
|
||||
run: bun run changelog:release
|
||||
|
||||
- name: Build release notes payload
|
||||
run: |
|
||||
if ! sh .gitea/scripts/extract-release-notes.sh "${{ steps.tag.outputs.value }}" > .gitea-release-notes.md; then
|
||||
echo "Could not isolate section for tag ${{ steps.tag.outputs.value }}. Falling back to full CHANGELOG.md."
|
||||
cp CHANGELOG.md .gitea-release-notes.md
|
||||
fi
|
||||
|
||||
- name: Login to image registry
|
||||
run: |
|
||||
echo "${{ secrets.CMS_IMAGE_REGISTRY_PASSWORD }}" | docker login "${{ env.REGISTRY }}" -u "${{ secrets.CMS_IMAGE_REGISTRY_USER }}" --password-stdin
|
||||
|
||||
- name: Build and push web image
|
||||
run: |
|
||||
image="${{ env.REGISTRY }}/${{ env.IMAGE_NAMESPACE }}/cms-web:${{ steps.tag.outputs.value }}"
|
||||
docker build -f apps/web/Dockerfile -t "$image" .
|
||||
docker push "$image"
|
||||
|
||||
- name: Build and push admin image
|
||||
run: |
|
||||
image="${{ env.REGISTRY }}/${{ env.IMAGE_NAMESPACE }}/cms-admin:${{ steps.tag.outputs.value }}"
|
||||
docker build -f apps/admin/Dockerfile -t "$image" .
|
||||
docker push "$image"
|
||||
|
||||
- name: Publish release notes to Gitea
|
||||
env:
|
||||
RELEASE_TAG: ${{ steps.tag.outputs.value }}
|
||||
RELEASE_NAME: ${{ steps.tag.outputs.value }}
|
||||
RELEASE_BODY_FILE: ".gitea-release-notes.md"
|
||||
GITEA_RELEASE_TOKEN: ${{ secrets.GITEA_RELEASE_TOKEN }}
|
||||
run: bun .gitea/scripts/publish-gitea-release.mjs
|
||||
|
||||
rollback:
|
||||
name: Rollback Production (Manual)
|
||||
if: github.event_name == 'workflow_dispatch' && github.event.inputs.rollback_image_tag != ''
|
||||
runs-on: node22-bun
|
||||
steps:
|
||||
- name: Setup SSH
|
||||
run: |
|
||||
mkdir -p ~/.ssh
|
||||
echo "${{ secrets.CMS_DEPLOY_KEY }}" > ~/.ssh/id_rsa
|
||||
chmod 600 ~/.ssh/id_rsa
|
||||
ssh-keyscan -H "${{ secrets.CMS_PRODUCTION_HOST }}" >> ~/.ssh/known_hosts
|
||||
|
||||
- name: Apply rollback image tag on production
|
||||
run: |
|
||||
ssh "${{ secrets.CMS_PRODUCTION_USER }}@${{ secrets.CMS_PRODUCTION_HOST }}" \
|
||||
"cd ${{ secrets.CMS_REMOTE_DEPLOY_PATH }} && CMS_IMAGE_TAG=${{ github.event.inputs.rollback_image_tag }} docker compose -f docker-compose.production.yml pull && CMS_IMAGE_TAG=${{ github.event.inputs.rollback_image_tag }} docker compose -f docker-compose.production.yml up -d"
|
||||
1
.gitignore
vendored
1
.gitignore
vendored
@@ -24,6 +24,7 @@ test-results
|
||||
!.env.example
|
||||
!.env.staging.example
|
||||
!.env.production.example
|
||||
!.env.gitea-runner.example
|
||||
|
||||
# prisma
|
||||
packages/db/prisma/dev.db*
|
||||
|
||||
@@ -96,6 +96,13 @@ Apply in repository settings:
|
||||
Optional:
|
||||
|
||||
- Protect `dev` from direct push if team size/process requires stricter control.
|
||||
- Automate protection via `.gitea/scripts/configure-branch-protection.sh`.
|
||||
|
||||
## Governance Automation
|
||||
|
||||
- Branch naming check: `.gitea/scripts/check-branch-name.sh`
|
||||
- PR TODO reference check: `.gitea/scripts/check-pr-todo-reference.sh`
|
||||
- PR template: `.gitea/PULL_REQUEST_TEMPLATE.md`
|
||||
|
||||
## Commit Signing Notes
|
||||
|
||||
|
||||
@@ -4,6 +4,8 @@
|
||||
|
||||
Follow `BRANCHING.md` for long-lived and task branch rules.
|
||||
|
||||
Pull requests should use `.gitea/PULL_REQUEST_TEMPLATE.md` and link the exact TODO item.
|
||||
|
||||
## Commit Message Schema
|
||||
|
||||
This repository uses Conventional Commits.
|
||||
|
||||
16
README.md
16
README.md
@@ -3,6 +3,7 @@
|
||||
Roadmap and progress are tracked in `TODO.md` (also visible in admin at `/todo`).
|
||||
Branch model and promotion flow are documented in `BRANCHING.md`.
|
||||
Commit schema and changelog workflow are documented in `CONTRIBUTING.md`.
|
||||
Versioning and release policy are documented in `VERSIONING.md`.
|
||||
|
||||
A baseline monorepo with:
|
||||
|
||||
@@ -96,10 +97,11 @@ bunx playwright install
|
||||
|
||||
## Delivery Scaffolding
|
||||
|
||||
The repo includes a theoretical CI/CD and deployment baseline:
|
||||
The repo includes a CI/CD and deployment baseline:
|
||||
|
||||
- Gitea workflow: `.gitea/workflows/ci-cd-theoretical.yml`
|
||||
- Real quality gate workflow: `.gitea/workflows/ci.yml`
|
||||
- Quality gate workflow: `.gitea/workflows/ci.yml`
|
||||
- Deployment workflow: `.gitea/workflows/deploy.yml`
|
||||
- Release workflow: `.gitea/workflows/release.yml`
|
||||
- App images:
|
||||
- `apps/web/Dockerfile`
|
||||
- `apps/admin/Dockerfile`
|
||||
@@ -118,12 +120,20 @@ Environment examples:
|
||||
|
||||
- `.env.staging.example`
|
||||
- `.env.production.example`
|
||||
- `.env.gitea-runner.example`
|
||||
|
||||
Notes:
|
||||
|
||||
- `dev` remains your local non-docker Bun workflow.
|
||||
- Staging and production compose files are templates and still require real secrets, registry strategy, and deployment host wiring.
|
||||
|
||||
Gitea Actions runner compose (self-hosted):
|
||||
|
||||
```bash
|
||||
cp .env.gitea-runner.example .env.gitea-runner
|
||||
docker compose --env-file .env.gitea-runner -f docker-compose.gitea-runner.yml up -d
|
||||
```
|
||||
|
||||
## Changelog
|
||||
|
||||
- Changelog file: `CHANGELOG.md`
|
||||
|
||||
56
TODO.md
56
TODO.md
@@ -73,37 +73,46 @@ This file is the single source of truth for roadmap and delivery progress.
|
||||
|
||||
- [x] [P1] Docs tool baseline added (`docs/` via VitePress)
|
||||
- [x] [P1] RBAC and permission model documentation in docs site
|
||||
- [ ] [P2] i18n conventions docs (keys, namespaces, fallback, translation workflow)
|
||||
- [~] [P1] CRUD base patterns documentation and examples
|
||||
- [ ] [P1] Environment and deployment runbook docs (dev/staging/production)
|
||||
- [ ] [P2] API and domain glossary pages
|
||||
- [ ] [P2] Architecture Decision Records (ADR) structure and first ADRs
|
||||
- [x] [P2] i18n conventions docs (keys, namespaces, fallback, translation workflow)
|
||||
- [x] [P1] CRUD base patterns documentation and examples
|
||||
- [x] [P1] Environment and deployment runbook docs (dev/staging/production)
|
||||
- [x] [P2] API and domain glossary pages
|
||||
- [x] [P2] Architecture Decision Records (ADR) structure and first ADRs
|
||||
|
||||
### Delivery Pipeline And Runtime
|
||||
|
||||
- [x] [P2] Theoretical Gitea Actions workflow scaffold (`.gitea/workflows/ci-cd-theoretical.yml`)
|
||||
- [x] [P2] Gitea workflow baseline (`.gitea/workflows/ci.yml`, `.gitea/workflows/deploy.yml`, `.gitea/workflows/release.yml`)
|
||||
- [x] [P2] Bun-based Dockerfiles for public and admin apps
|
||||
- [x] [P2] Staging and production docker-compose templates
|
||||
- [ ] [P1] Registry credentials and image push strategy
|
||||
- [ ] [P1] Staging deployment automation against real host
|
||||
- [ ] [P1] Production promotion and rollback procedure
|
||||
- [x] [P1] Registry credentials and image push strategy
|
||||
- [~] [P1] Staging deployment automation against real host
|
||||
- [~] [P1] Production promotion and rollback procedure
|
||||
|
||||
### Git Flow And Branching
|
||||
|
||||
- [ ] [P1] Protect `main` and `staging` branches in Gitea
|
||||
- [ ] [P1] Define PR gates: lint + typecheck + unit + e2e list minimum
|
||||
- [ ] [P1] Enforce one todo item per branch naming convention
|
||||
- [ ] [P2] Add PR template requiring linked TODO step
|
||||
- [ ] [P2] Define branch lifecycle for `todo/*`, `refactor/*`, and `code/*`
|
||||
- [~] [P1] Protect `main` and `staging` branches in Gitea
|
||||
- [x] [P1] Define PR gates: lint + typecheck + unit + e2e list minimum
|
||||
- [x] [P1] Enforce one todo item per branch naming convention
|
||||
- [x] [P2] Add PR template requiring linked TODO step
|
||||
- [x] [P2] Define branch lifecycle for `todo/*`, `refactor/*`, and `code/*`
|
||||
- [x] [P2] Conventional commit schema documentation (`CONTRIBUTING.md`)
|
||||
- [x] [P2] Changelog scaffold and generation scripts (`CHANGELOG.md`, `bun run changelog:*`)
|
||||
- [ ] [P1] Versioning policy definition (SemVer strategy + when to bump major/minor/patch)
|
||||
- [ ] [P1] Source of truth for version (`package.json` root) and release tagging rules (`vX.Y.Z`)
|
||||
- [ ] [P1] Build metadata policy for git hash (`+sha.<short>`) in app runtime footer
|
||||
- [ ] [P1] App footer implementation plan for version + commit hash (admin + web)
|
||||
- [ ] [P2] Automated version injection in CI (stamping build from tag + commit hash)
|
||||
- [ ] [P2] Validation tests for displayed version/hash consistency per deployment
|
||||
- [ ] [P1] Release tagging and changelog publication policy in CI
|
||||
- [x] [P1] Versioning policy definition (SemVer strategy + when to bump major/minor/patch)
|
||||
- [x] [P1] Source of truth for version (`package.json` root) and release tagging rules (`vX.Y.Z`)
|
||||
- [x] [P1] Build metadata policy for git hash (`+sha.<short>`) in app runtime footer
|
||||
- [x] [P1] App footer implementation plan for version + commit hash (admin + web)
|
||||
- [x] [P2] Automated version injection in CI (stamping build from tag + commit hash)
|
||||
- [x] [P2] Validation tests for displayed version/hash consistency per deployment
|
||||
- [x] [P1] Release tagging and changelog publication policy in CI
|
||||
|
||||
### MVP0 Close-Out Checklist
|
||||
|
||||
- [~] [P1] Verify and document protected branch rules in Gitea (`main`, `staging`)
|
||||
- [ ] [P1] Run first staging deployment against a real host with deploy workflow and document result
|
||||
- [x] [P1] Replace release workflow placeholders with real release-notes and rollback execution steps
|
||||
- [x] [P1] Expose runtime version + short git hash in admin and public app footer
|
||||
- [x] [P2] Add CI build stamping for version/hash values consumed by app footers
|
||||
- [x] [P2] Add automated tests validating displayed version/hash format and consistency
|
||||
|
||||
## MVP 1: Core CMS Business Features
|
||||
|
||||
@@ -206,6 +215,11 @@ This file is the single source of truth for roadmap and delivery progress.
|
||||
- [2026-02-10] Admin app now uses a shared shell with permission-aware navigation and dedicated IA routes (`/pages`, `/media`, `/users`, `/commissions`).
|
||||
- [2026-02-10] Public app now has a shared site layout (`banner/header/footer`), DB-backed header banner config, and SEO defaults (`metadata`, `robots`, `sitemap`).
|
||||
- [2026-02-10] Testing baseline now includes explicit RBAC regression checks, locale-resolution unit tests (admin/web), CRUD service contract tests, and i18n smoke e2e routes.
|
||||
- [2026-02-10] i18n conventions are now documented as an engineering standard (`docs/product-engineering/i18n-conventions.md`).
|
||||
- [2026-02-10] Docs now include a domain glossary, public API glossary, and ADR baseline with initial accepted decision (`ADR 0001`).
|
||||
- [2026-02-10] Delivery and release governance now include branch/PR policy checks, deploy/release workflows, and explicit versioning policy (`VERSIONING.md`).
|
||||
- [2026-02-11] Release workflow now publishes changelog-derived notes to Gitea releases and supports executable production rollback via SSH + compose tag switch.
|
||||
- [2026-02-11] Branch protection verification checklist is now documented; final UI-level verification remains environment-specific.
|
||||
|
||||
## How We Use This File
|
||||
|
||||
|
||||
71
VERSIONING.md
Normal file
71
VERSIONING.md
Normal file
@@ -0,0 +1,71 @@
|
||||
# Versioning Policy
|
||||
|
||||
## Source Of Truth
|
||||
|
||||
- Canonical version: root `package.json` field `version`
|
||||
- Tag format: `vX.Y.Z`
|
||||
|
||||
Tag validation is enforced in CI:
|
||||
|
||||
- `.gitea/scripts/validate-tag-version.sh`
|
||||
|
||||
## SemVer Strategy
|
||||
|
||||
- `major`: breaking API/behavior changes
|
||||
- `minor`: backward-compatible features
|
||||
- `patch`: backward-compatible fixes
|
||||
|
||||
## Build Metadata Policy
|
||||
|
||||
Use git metadata in runtime display format:
|
||||
|
||||
- `<version>+sha.<short>`
|
||||
|
||||
Example:
|
||||
|
||||
- `0.1.0+sha.a1b2c3d`
|
||||
|
||||
## Footer Display Plan (Admin + Web)
|
||||
|
||||
Planned runtime footer fields:
|
||||
|
||||
- app name
|
||||
- version from root `package.json`
|
||||
- commit hash (short)
|
||||
- environment (`dev|staging|production`)
|
||||
|
||||
Implementation note:
|
||||
|
||||
- inject values at build/deploy time through env vars
|
||||
- render in shared footer components
|
||||
|
||||
## CI Version Injection
|
||||
|
||||
Release/deploy workflows pass release tag and commit metadata:
|
||||
|
||||
- `.gitea/workflows/release.yml`
|
||||
- `.gitea/workflows/deploy.yml`
|
||||
|
||||
Required inputs:
|
||||
|
||||
- release tag (`vX.Y.Z`)
|
||||
- image tag for deployment
|
||||
|
||||
## Validation Strategy
|
||||
|
||||
CI validations:
|
||||
|
||||
- tag equals `v${package.json.version}`
|
||||
- required checks pass before release builds
|
||||
|
||||
Runtime validations (planned):
|
||||
|
||||
- smoke tests assert footer version/hash format
|
||||
- environment-specific deployment checks assert expected image tag
|
||||
|
||||
## Changelog and Release Publication
|
||||
|
||||
- changelog generation command:
|
||||
- `bun run changelog:release`
|
||||
- release workflow generates changelog on tag pipeline
|
||||
- release notes publication remains a dedicated step in CI workflow.
|
||||
@@ -4,6 +4,7 @@ import type { ReactNode } from "react"
|
||||
|
||||
import { LogoutButton } from "@/app/logout-button"
|
||||
import { AdminLocaleSwitcher } from "@/components/admin-locale-switcher"
|
||||
import { getBuildInfo } from "@/lib/build-info"
|
||||
|
||||
type AdminShellProps = {
|
||||
role: Role
|
||||
@@ -57,6 +58,8 @@ export function AdminShell({
|
||||
actions,
|
||||
children,
|
||||
}: AdminShellProps) {
|
||||
const buildInfo = getBuildInfo()
|
||||
|
||||
return (
|
||||
<div className="mx-auto flex min-h-screen w-full max-w-7xl gap-8 px-6 py-10">
|
||||
<aside className="sticky top-0 hidden h-fit w-64 shrink-0 space-y-4 lg:block">
|
||||
@@ -111,6 +114,10 @@ export function AdminShell({
|
||||
</header>
|
||||
|
||||
{children}
|
||||
|
||||
<footer className="border-t border-neutral-200 pt-4 text-xs text-neutral-500">
|
||||
Build v{buildInfo.version} +sha.{buildInfo.sha}
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
)
|
||||
|
||||
29
apps/admin/src/lib/build-info.test.ts
Normal file
29
apps/admin/src/lib/build-info.test.ts
Normal file
@@ -0,0 +1,29 @@
|
||||
import { afterEach, describe, expect, it, vi } from "vitest"
|
||||
|
||||
import { getBuildInfo } from "./build-info"
|
||||
|
||||
afterEach(() => {
|
||||
vi.unstubAllEnvs()
|
||||
})
|
||||
|
||||
describe("getBuildInfo (admin)", () => {
|
||||
it("returns fallback values when env is missing", () => {
|
||||
vi.stubEnv("NEXT_PUBLIC_APP_VERSION", "")
|
||||
vi.stubEnv("NEXT_PUBLIC_GIT_SHA", "")
|
||||
|
||||
expect(getBuildInfo()).toEqual({
|
||||
version: "0.0.1-dev",
|
||||
sha: "local",
|
||||
})
|
||||
})
|
||||
|
||||
it("uses env values and truncates git sha", () => {
|
||||
vi.stubEnv("NEXT_PUBLIC_APP_VERSION", "0.2.0")
|
||||
vi.stubEnv("NEXT_PUBLIC_GIT_SHA", "abcdef123456")
|
||||
|
||||
expect(getBuildInfo()).toEqual({
|
||||
version: "0.2.0",
|
||||
sha: "abcdef1",
|
||||
})
|
||||
})
|
||||
})
|
||||
21
apps/admin/src/lib/build-info.ts
Normal file
21
apps/admin/src/lib/build-info.ts
Normal file
@@ -0,0 +1,21 @@
|
||||
const FALLBACK_VERSION = "0.0.1-dev"
|
||||
const FALLBACK_SHA = "local"
|
||||
|
||||
function shortenSha(input: string): string {
|
||||
const value = input.trim()
|
||||
if (!value) {
|
||||
return FALLBACK_SHA
|
||||
}
|
||||
|
||||
return value.slice(0, 7)
|
||||
}
|
||||
|
||||
export function getBuildInfo() {
|
||||
const version = process.env.NEXT_PUBLIC_APP_VERSION?.trim() || FALLBACK_VERSION
|
||||
const sha = shortenSha(process.env.NEXT_PUBLIC_GIT_SHA ?? "")
|
||||
|
||||
return {
|
||||
version,
|
||||
sha,
|
||||
}
|
||||
}
|
||||
@@ -2,9 +2,12 @@
|
||||
|
||||
import { useTranslations } from "next-intl"
|
||||
|
||||
import { getBuildInfo } from "@/lib/build-info"
|
||||
|
||||
export function PublicSiteFooter() {
|
||||
const t = useTranslations("Layout")
|
||||
const year = new Date().getFullYear()
|
||||
const buildInfo = getBuildInfo()
|
||||
|
||||
return (
|
||||
<footer className="border-t border-neutral-200 bg-neutral-50">
|
||||
@@ -15,6 +18,9 @@ export function PublicSiteFooter() {
|
||||
})}
|
||||
</p>
|
||||
<p>{t("footer.tagline")}</p>
|
||||
<p className="font-mono text-xs text-neutral-500">
|
||||
Build v{buildInfo.version} +sha.{buildInfo.sha}
|
||||
</p>
|
||||
</div>
|
||||
</footer>
|
||||
)
|
||||
|
||||
29
apps/web/src/lib/build-info.test.ts
Normal file
29
apps/web/src/lib/build-info.test.ts
Normal file
@@ -0,0 +1,29 @@
|
||||
import { afterEach, describe, expect, it, vi } from "vitest"
|
||||
|
||||
import { getBuildInfo } from "./build-info"
|
||||
|
||||
afterEach(() => {
|
||||
vi.unstubAllEnvs()
|
||||
})
|
||||
|
||||
describe("getBuildInfo (web)", () => {
|
||||
it("returns fallback values when env is missing", () => {
|
||||
vi.stubEnv("NEXT_PUBLIC_APP_VERSION", "")
|
||||
vi.stubEnv("NEXT_PUBLIC_GIT_SHA", "")
|
||||
|
||||
expect(getBuildInfo()).toEqual({
|
||||
version: "0.0.1-dev",
|
||||
sha: "local",
|
||||
})
|
||||
})
|
||||
|
||||
it("uses env values and truncates git sha", () => {
|
||||
vi.stubEnv("NEXT_PUBLIC_APP_VERSION", "0.2.0")
|
||||
vi.stubEnv("NEXT_PUBLIC_GIT_SHA", "123456789abc")
|
||||
|
||||
expect(getBuildInfo()).toEqual({
|
||||
version: "0.2.0",
|
||||
sha: "1234567",
|
||||
})
|
||||
})
|
||||
})
|
||||
21
apps/web/src/lib/build-info.ts
Normal file
21
apps/web/src/lib/build-info.ts
Normal file
@@ -0,0 +1,21 @@
|
||||
const FALLBACK_VERSION = "0.0.1-dev"
|
||||
const FALLBACK_SHA = "local"
|
||||
|
||||
function shortenSha(input: string): string {
|
||||
const value = input.trim()
|
||||
if (!value) {
|
||||
return FALLBACK_SHA
|
||||
}
|
||||
|
||||
return value.slice(0, 7)
|
||||
}
|
||||
|
||||
export function getBuildInfo() {
|
||||
const version = process.env.NEXT_PUBLIC_APP_VERSION?.trim() || FALLBACK_VERSION
|
||||
const sha = shortenSha(process.env.NEXT_PUBLIC_GIT_SHA ?? "")
|
||||
|
||||
return {
|
||||
version,
|
||||
sha,
|
||||
}
|
||||
}
|
||||
@@ -6,7 +6,7 @@ module.exports = {
|
||||
"always",
|
||||
["feat", "fix", "refactor", "perf", "test", "docs", "build", "ci", "chore", "revert"],
|
||||
],
|
||||
"scope-empty": [2, "never"],
|
||||
"scope-empty": [0],
|
||||
"subject-empty": [2, "never"],
|
||||
},
|
||||
}
|
||||
|
||||
13
docker-compose.gitea-runner.yml
Normal file
13
docker-compose.gitea-runner.yml
Normal file
@@ -0,0 +1,13 @@
|
||||
services:
|
||||
gitea-runner:
|
||||
image: gitea/act_runner:latest
|
||||
container_name: cms-gitea-runner
|
||||
restart: unless-stopped
|
||||
environment:
|
||||
GITEA_INSTANCE_URL: "${GITEA_INSTANCE_URL}"
|
||||
GITEA_RUNNER_REGISTRATION_TOKEN: "${GITEA_RUNNER_REGISTRATION_TOKEN}"
|
||||
GITEA_RUNNER_NAME: "${GITEA_RUNNER_NAME:-cms-runner}"
|
||||
GITEA_RUNNER_LABELS: "${GITEA_RUNNER_LABELS:-ubuntu-latest:docker://node:20-bookworm}"
|
||||
volumes:
|
||||
- ./runner-data:/data
|
||||
- /var/run/docker.sock:/var/run/docker.sock
|
||||
@@ -21,9 +21,16 @@ export default defineConfig({
|
||||
{ text: "Architecture", link: "/architecture" },
|
||||
{ text: "Better Auth Baseline", link: "/product-engineering/auth-baseline" },
|
||||
{ text: "CRUD Baseline", link: "/product-engineering/crud-baseline" },
|
||||
{ text: "CRUD Examples", link: "/product-engineering/crud-examples" },
|
||||
{ text: "i18n Baseline", link: "/product-engineering/i18n-baseline" },
|
||||
{ text: "i18n Conventions", link: "/product-engineering/i18n-conventions" },
|
||||
{ text: "RBAC And Permissions", link: "/product-engineering/rbac-permission-model" },
|
||||
{ text: "Domain Glossary", link: "/product-engineering/domain-glossary" },
|
||||
{ text: "Environment Runbook", link: "/product-engineering/environment-runbook" },
|
||||
{ text: "Delivery Pipeline", link: "/product-engineering/delivery-pipeline" },
|
||||
{ text: "Git Flow Governance", link: "/product-engineering/git-flow-governance" },
|
||||
{ text: "Testing Strategy", link: "/product-engineering/testing-strategy" },
|
||||
{ text: "ADR Index", link: "/adr/" },
|
||||
{ text: "Workflow", link: "/workflow" },
|
||||
],
|
||||
},
|
||||
@@ -33,7 +40,17 @@ export default defineConfig({
|
||||
},
|
||||
{
|
||||
text: "Public API",
|
||||
items: [{ text: "Section Overview", link: "/public-api/" }],
|
||||
items: [
|
||||
{ text: "Section Overview", link: "/public-api/" },
|
||||
{ text: "Glossary", link: "/public-api/glossary" },
|
||||
],
|
||||
},
|
||||
{
|
||||
text: "ADR",
|
||||
items: [
|
||||
{ text: "Index", link: "/adr/" },
|
||||
{ text: "0001 Monorepo Foundation", link: "/adr/0001-monorepo-foundation" },
|
||||
],
|
||||
},
|
||||
],
|
||||
socialLinks: [{ icon: "github", link: "https://example.com/replace-with-repo" }],
|
||||
|
||||
37
docs/adr/0001-monorepo-foundation.md
Normal file
37
docs/adr/0001-monorepo-foundation.md
Normal file
@@ -0,0 +1,37 @@
|
||||
# ADR 0001: Monorepo Foundation
|
||||
|
||||
- Status: Accepted
|
||||
- Date: 2026-02-10
|
||||
|
||||
## Context
|
||||
|
||||
The CMS platform requires:
|
||||
|
||||
- separate admin and public apps
|
||||
- shared domain contracts and data access
|
||||
- consistent tooling and CI quality gates
|
||||
- incremental delivery through MVP stages
|
||||
|
||||
A fragmented multi-repo setup would increase coordination overhead and duplicate shared contracts.
|
||||
|
||||
## Decision
|
||||
|
||||
Adopt a Bun workspace monorepo with:
|
||||
|
||||
- `apps/admin` and `apps/web` for runtime surfaces
|
||||
- shared packages (`@cms/content`, `@cms/db`, `@cms/crud`, `@cms/ui`, `@cms/i18n`)
|
||||
- shared quality tooling (Biome, TypeScript, Vitest, Playwright, Turbo)
|
||||
|
||||
## Consequences
|
||||
|
||||
### Positive
|
||||
|
||||
- shared contract updates propagate in one change set
|
||||
- easier cross-app refactors and testing
|
||||
- single CI pipeline with consistent gates
|
||||
|
||||
### Negative
|
||||
|
||||
- stronger need for workspace discipline and clear boundaries
|
||||
- larger repository clone/build surface
|
||||
- potential for cross-package coupling if conventions are not enforced
|
||||
17
docs/adr/README.md
Normal file
17
docs/adr/README.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# ADR Index
|
||||
|
||||
Architecture Decision Records (ADRs) capture important technical decisions and context.
|
||||
|
||||
## Format
|
||||
|
||||
- Numbered files: `0001-<short-title>.md`
|
||||
- Immutable once accepted (new ADRs supersede old decisions)
|
||||
- Include:
|
||||
- Status
|
||||
- Context
|
||||
- Decision
|
||||
- Consequences
|
||||
|
||||
## Records
|
||||
|
||||
- [0001 - Monorepo Foundation](./0001-monorepo-foundation.md)
|
||||
@@ -7,6 +7,7 @@ Engineering documentation hub for this repository.
|
||||
- [Product / Engineering](/product-engineering/)
|
||||
- [Admin / User Guides](/admin-user-guides/)
|
||||
- [Public API](/public-api/)
|
||||
- [ADR Index](/adr/)
|
||||
|
||||
## Core Sources
|
||||
|
||||
@@ -14,6 +15,7 @@ Engineering documentation hub for this repository.
|
||||
- Branching and promotion flow: `BRANCHING.md`
|
||||
- Contribution and commit schema: `CONTRIBUTING.md`
|
||||
- Release history: `CHANGELOG.md`
|
||||
- Versioning and release policy: `VERSIONING.md`
|
||||
|
||||
## Documentation Scope
|
||||
|
||||
|
||||
@@ -38,3 +38,4 @@ The admin dashboard currently includes a temporary posts CRUD sandbox to validat
|
||||
|
||||
- This is the base layer for future entities (pages, navigation, media, users, commissions).
|
||||
- Audit hook persistence/transport is intentionally left for later implementation work.
|
||||
- Implementation examples are documented in `crud-examples.md`.
|
||||
|
||||
69
docs/product-engineering/crud-examples.md
Normal file
69
docs/product-engineering/crud-examples.md
Normal file
@@ -0,0 +1,69 @@
|
||||
# CRUD Examples
|
||||
|
||||
## Goal
|
||||
|
||||
Provide concrete implementation patterns for new entities adopting `@cms/crud`.
|
||||
|
||||
## Example: Service Factory Wiring
|
||||
|
||||
```ts
|
||||
import { createCrudService } from "@cms/crud"
|
||||
import { createPageInputSchema, updatePageInputSchema } from "@cms/content"
|
||||
|
||||
const pageCrudService = createCrudService({
|
||||
resource: "page",
|
||||
repository: pageRepository,
|
||||
schemas: {
|
||||
create: createPageInputSchema,
|
||||
update: updatePageInputSchema,
|
||||
},
|
||||
auditHooks: pageAuditHooks,
|
||||
})
|
||||
```
|
||||
|
||||
## Example: Repository Contract
|
||||
|
||||
```ts
|
||||
const pageRepository = {
|
||||
list: () => db.page.findMany({ orderBy: { updatedAt: "desc" } }),
|
||||
findById: (id: string) => db.page.findUnique({ where: { id } }),
|
||||
create: (input: CreatePageInput) => db.page.create({ data: input }),
|
||||
update: (id: string, input: UpdatePageInput) =>
|
||||
db.page.update({
|
||||
where: { id },
|
||||
data: input,
|
||||
}),
|
||||
delete: (id: string) => db.page.delete({ where: { id } }),
|
||||
}
|
||||
```
|
||||
|
||||
## Example: Action Usage
|
||||
|
||||
```ts
|
||||
export async function createPage(input: unknown, context?: CrudMutationContext) {
|
||||
return pageCrudService.create(input, context)
|
||||
}
|
||||
|
||||
export async function updatePage(id: string, input: unknown, context?: CrudMutationContext) {
|
||||
return pageCrudService.update(id, input, context)
|
||||
}
|
||||
|
||||
export async function deletePage(id: string, context?: CrudMutationContext) {
|
||||
return pageCrudService.delete(id, context)
|
||||
}
|
||||
```
|
||||
|
||||
## Testing Expectations
|
||||
|
||||
- validation failure returns `CrudValidationError`
|
||||
- missing IDs return `CrudNotFoundError`
|
||||
- repository methods are called in expected order
|
||||
- audit hooks receive `actor`, `metadata`, `before`, `after`
|
||||
|
||||
## Adoption Checklist
|
||||
|
||||
1. Add entity schemas in `@cms/content`
|
||||
2. Add repository + service in `@cms/db`
|
||||
3. Add unit tests for contract + validation
|
||||
4. Wire route/action permission checks before mutations
|
||||
5. Add docs links and TODO updates
|
||||
83
docs/product-engineering/delivery-pipeline.md
Normal file
83
docs/product-engineering/delivery-pipeline.md
Normal file
@@ -0,0 +1,83 @@
|
||||
# Delivery Pipeline
|
||||
|
||||
## Scope
|
||||
|
||||
Operational pipeline baseline for image build/push, staging deploy, production promotion, and rollback.
|
||||
|
||||
## Registry Credentials Strategy
|
||||
|
||||
Use scoped Gitea secrets:
|
||||
|
||||
- `CMS_IMAGE_REGISTRY`
|
||||
- `CMS_IMAGE_NAMESPACE`
|
||||
- `CMS_IMAGE_REGISTRY_USER`
|
||||
- `CMS_IMAGE_REGISTRY_PASSWORD`
|
||||
|
||||
Policy:
|
||||
|
||||
- credentials only in CI secrets
|
||||
- no plaintext credentials in repo
|
||||
- least privilege: push/pull for target namespace only
|
||||
|
||||
## Build and Push Flow
|
||||
|
||||
- Workflow: `.gitea/workflows/release.yml`
|
||||
- Trigger:
|
||||
- tag push `vX.Y.Z`
|
||||
- manual `workflow_dispatch`
|
||||
- Steps:
|
||||
1. validate tag vs root `package.json` version
|
||||
2. generate changelog
|
||||
3. extract release notes from `CHANGELOG.md`
|
||||
4. docker login
|
||||
5. build and push `cms-web` and `cms-admin` images
|
||||
6. publish/update Gitea release notes through API
|
||||
|
||||
Additional required secret:
|
||||
|
||||
- `GITEA_RELEASE_TOKEN`
|
||||
|
||||
## Staging Deployment Automation
|
||||
|
||||
- Workflow: `.gitea/workflows/deploy.yml`
|
||||
- Manual input:
|
||||
- `environment=staging`
|
||||
- `image_tag=vX.Y.Z`
|
||||
- Remote deployment uses SSH + compose file:
|
||||
- `docker-compose.staging.yml`
|
||||
|
||||
Required secrets:
|
||||
|
||||
- `CMS_STAGING_HOST`
|
||||
- `CMS_STAGING_USER`
|
||||
- `CMS_DEPLOY_KEY`
|
||||
- `CMS_REMOTE_DEPLOY_PATH`
|
||||
|
||||
## Production Promotion and Rollback
|
||||
|
||||
Promotion:
|
||||
|
||||
- run deploy workflow with:
|
||||
- `environment=production`
|
||||
- `image_tag=vX.Y.Z`
|
||||
|
||||
Rollback:
|
||||
|
||||
- release workflow supports manual production rollback by `rollback_image_tag`
|
||||
- deploy workflow supports `rollback_tag` input for environment-specific rollback
|
||||
- recovery action:
|
||||
- rerun deploy/rollback with previous known-good tag
|
||||
|
||||
## Deployment Verification
|
||||
|
||||
After deploy:
|
||||
|
||||
1. app health checks (web/admin)
|
||||
2. auth smoke flow
|
||||
3. i18n smoke flow
|
||||
4. critical route checks (`/`, `/login`, `/todo`)
|
||||
|
||||
## Notes
|
||||
|
||||
- Current workflows are production-oriented scaffolds and require secret provisioning in Gitea.
|
||||
- Host hardening, network ACLs, and backup policy remain mandatory operational controls.
|
||||
35
docs/product-engineering/domain-glossary.md
Normal file
35
docs/product-engineering/domain-glossary.md
Normal file
@@ -0,0 +1,35 @@
|
||||
# Domain Glossary
|
||||
|
||||
## Core Terms
|
||||
|
||||
### Owner
|
||||
|
||||
Highest-privilege admin role. Exactly one canonical owner must exist at all times.
|
||||
|
||||
### Support User
|
||||
|
||||
Hidden technical support account used for break-glass access and operational recovery.
|
||||
|
||||
### Admin Registration Policy
|
||||
|
||||
Runtime policy controlling whether `/register` can create additional admin users after owner bootstrap.
|
||||
|
||||
### Protected Account
|
||||
|
||||
Account that cannot be deleted/demoted through self-service flows (support + canonical owner).
|
||||
|
||||
### CRUD Service
|
||||
|
||||
Shared `@cms/crud` service abstraction combining schema validation, repository orchestration, and audit hooks.
|
||||
|
||||
### Permission Scope
|
||||
|
||||
RBAC access scope granularity: `own`, `team`, `global`.
|
||||
|
||||
### Roadmap Source Of Truth
|
||||
|
||||
`TODO.md` in repository root. Rendered in admin via `/todo`.
|
||||
|
||||
### Header Banner
|
||||
|
||||
Public-site announcement strip configured through `system_setting` key `public.header_banner`.
|
||||
103
docs/product-engineering/environment-runbook.md
Normal file
103
docs/product-engineering/environment-runbook.md
Normal file
@@ -0,0 +1,103 @@
|
||||
# Environment and Deployment Runbook
|
||||
|
||||
## Scope
|
||||
|
||||
Operational baseline for `dev`, `staging`, and `production`.
|
||||
|
||||
## Environments
|
||||
|
||||
### Dev (local)
|
||||
|
||||
- Runtime: Bun + local Next dev servers
|
||||
- Entry point: `bun run dev`
|
||||
- Database: local/remote dev Postgres from `.env`
|
||||
- Characteristics:
|
||||
- fastest feedback
|
||||
- non-production data acceptable
|
||||
- migrations created here first
|
||||
|
||||
### Staging
|
||||
|
||||
- Runtime: Docker Compose (`docker-compose.staging.yml`)
|
||||
- Purpose: integration validation and release candidate checks
|
||||
- Characteristics:
|
||||
- production-like environment
|
||||
- controlled test data
|
||||
- candidate for production promotion
|
||||
|
||||
### Production
|
||||
|
||||
- Runtime: Docker Compose (`docker-compose.production.yml`)
|
||||
- Purpose: end-user traffic
|
||||
- Characteristics:
|
||||
- protected secrets and stricter access controls
|
||||
- immutable release artifacts
|
||||
- rollback procedures required
|
||||
|
||||
## Core Commands
|
||||
|
||||
### Local development
|
||||
|
||||
```bash
|
||||
bun install
|
||||
bun run db:generate
|
||||
bun run db:migrate
|
||||
bun run db:seed
|
||||
bun run dev
|
||||
```
|
||||
|
||||
### Staging compose
|
||||
|
||||
```bash
|
||||
bun run docker:staging:up
|
||||
bun run docker:staging:down
|
||||
```
|
||||
|
||||
### Production compose
|
||||
|
||||
```bash
|
||||
bun run docker:production:up
|
||||
bun run docker:production:down
|
||||
```
|
||||
|
||||
## Release Flow
|
||||
|
||||
1. Complete work on task branch.
|
||||
2. Merge into `dev` and pass quality gates.
|
||||
3. Promote `dev` -> `staging`.
|
||||
4. Validate staging smoke/e2e + manual checks.
|
||||
5. Promote `staging` -> `main` and tag release.
|
||||
|
||||
## Migration Policy
|
||||
|
||||
- Create migrations in development only.
|
||||
- Apply migrations in deployment using `prisma migrate deploy`.
|
||||
- Never hand-edit applied migration history.
|
||||
|
||||
## Rollback Baseline
|
||||
|
||||
Current baseline strategy:
|
||||
|
||||
- rollback app image/tag to previous known-good release
|
||||
- restore database from backup when schema/data changes require recovery
|
||||
|
||||
## Secrets and Config
|
||||
|
||||
- Dev: `.env`
|
||||
- Staging: `.env.staging` (from `.env.staging.example`)
|
||||
- Production: `.env.production` (from `.env.production.example`)
|
||||
|
||||
Minimum sensitive values:
|
||||
|
||||
- `DATABASE_URL`
|
||||
- `BETTER_AUTH_SECRET`
|
||||
- `CMS_SUPPORT_*` credentials/keys
|
||||
|
||||
## Verification Checklist
|
||||
|
||||
- `bun run check`
|
||||
- `bun run typecheck`
|
||||
- `bun run test`
|
||||
- `bun run test:e2e`
|
||||
- app startup health for web/admin
|
||||
- login flow and permissions smoke
|
||||
93
docs/product-engineering/git-flow-governance.md
Normal file
93
docs/product-engineering/git-flow-governance.md
Normal file
@@ -0,0 +1,93 @@
|
||||
# Git Flow Governance
|
||||
|
||||
## Scope
|
||||
|
||||
Governance rules for branch protections, PR gates, branch naming, and merge discipline.
|
||||
|
||||
## Branch Protection
|
||||
|
||||
Protected branches:
|
||||
|
||||
- `main`
|
||||
- `staging`
|
||||
|
||||
Apply protections using:
|
||||
|
||||
- Gitea UI settings
|
||||
- or automation script: `.gitea/scripts/configure-branch-protection.sh`
|
||||
|
||||
Minimum policy:
|
||||
|
||||
- no direct pushes
|
||||
- PR merge required
|
||||
- required status checks
|
||||
- at least one reviewer approval
|
||||
|
||||
## Branch Protection Verification Checklist
|
||||
|
||||
Use this checklist in Gitea repository settings after applying policy:
|
||||
|
||||
1. `main` protection exists and direct push is disabled.
|
||||
2. `staging` protection exists and direct push is disabled.
|
||||
3. Required checks include:
|
||||
- `Governance Checks`
|
||||
- `Lint Typecheck Unit E2E`
|
||||
4. Pull request approval is required.
|
||||
5. Branch must be up to date before merge (recommended in protected branches).
|
||||
|
||||
API automation example:
|
||||
|
||||
```bash
|
||||
sh .gitea/scripts/configure-branch-protection.sh \
|
||||
"$GITEA_URL" \
|
||||
"$GITEA_OWNER" \
|
||||
"$GITEA_REPO" \
|
||||
"$GITEA_ADMIN_TOKEN"
|
||||
```
|
||||
|
||||
Notes:
|
||||
|
||||
- The script applies baseline protection for `main` and `staging`.
|
||||
- Final verification is still required in the Gitea UI to confirm repository-specific policies.
|
||||
|
||||
## PR Gates
|
||||
|
||||
Required checks are implemented in `.gitea/workflows/ci.yml`:
|
||||
|
||||
- Governance Checks
|
||||
- Lint Typecheck Unit E2E
|
||||
|
||||
## Branch Naming and TODO Scope
|
||||
|
||||
Allowed branch prefixes:
|
||||
|
||||
- `todo/`
|
||||
- `refactor/`
|
||||
- `code/`
|
||||
|
||||
Validation script:
|
||||
|
||||
- `.gitea/scripts/check-branch-name.sh`
|
||||
|
||||
Rule:
|
||||
|
||||
- one primary TODO item per delivery branch
|
||||
|
||||
PR TODO reference enforcement:
|
||||
|
||||
- template: `.gitea/PULL_REQUEST_TEMPLATE.md`
|
||||
- CI check: `.gitea/scripts/check-pr-todo-reference.sh`
|
||||
|
||||
## Branch Lifecycle
|
||||
|
||||
1. Create short-lived branch from latest integration tip.
|
||||
2. Implement one primary scope.
|
||||
3. Open PR and pass required checks.
|
||||
4. Merge into `dev`.
|
||||
5. Promote `dev -> staging -> main`.
|
||||
|
||||
## Commit and Tag Policy
|
||||
|
||||
- Conventional commits required (`CONTRIBUTING.md`)
|
||||
- release tags: `vX.Y.Z`
|
||||
- changelog generated from commit history
|
||||
@@ -18,4 +18,4 @@ Current baseline:
|
||||
|
||||
- Public app locale is resolved through `next-intl` middleware + cookie.
|
||||
- Enabled locales are currently static in code and will later be managed from admin settings.
|
||||
- Translation key conventions and workflow docs are tracked in `TODO.md`.
|
||||
- Translation key and workflow standards are documented in `i18n-conventions.md`.
|
||||
|
||||
86
docs/product-engineering/i18n-conventions.md
Normal file
86
docs/product-engineering/i18n-conventions.md
Normal file
@@ -0,0 +1,86 @@
|
||||
# i18n Conventions
|
||||
|
||||
## Scope
|
||||
|
||||
This document defines translation conventions for both apps in MVP0+.
|
||||
|
||||
- Public app i18n: `next-intl` message namespaces and route-level usage
|
||||
- Admin app i18n: JSON dictionaries + runtime resolver/provider
|
||||
- Shared locale contract: `@cms/i18n` (`de`, `en`, `es`, `fr`; default `en`)
|
||||
|
||||
## Locale Policy
|
||||
|
||||
- Source of truth: `packages/i18n/src/index.ts`
|
||||
- Current enabled locales are code-driven and shared across web/admin.
|
||||
- Admin-managed locale toggles are planned for a later MVP.
|
||||
|
||||
## Key Naming Conventions
|
||||
|
||||
- Use `camelCase` for keys.
|
||||
- Group by domain namespace (not by component filename).
|
||||
- Keep keys stable; update values, not key names, during copy edits.
|
||||
|
||||
### Public app namespaces
|
||||
|
||||
- `Layout.*`
|
||||
- `Home.*`
|
||||
- `LanguageSwitcher.*`
|
||||
- Page-specific namespaces, e.g. `About.*`, `Contact.*`
|
||||
- Metadata namespace: `Seo.*`
|
||||
|
||||
### Admin app namespaces
|
||||
|
||||
- `common.*`
|
||||
- `auth.*`
|
||||
- `dashboard.*`
|
||||
- `settings.*`
|
||||
|
||||
## Message Structure
|
||||
|
||||
- Keep messages as nested JSON objects.
|
||||
- Avoid very deep nesting (prefer 2-3 levels).
|
||||
- Keep punctuation in translation values, not code.
|
||||
- Avoid embedding HTML in message strings.
|
||||
|
||||
## Fallback Rules
|
||||
|
||||
- Unknown/invalid locale values fallback to default locale `en`.
|
||||
- Missing translation key behavior:
|
||||
- Admin: `translateMessage` returns provided fallback, else key.
|
||||
- Public: ensure required keys exist in locale JSON; avoid runtime missing-key states.
|
||||
|
||||
## Adding New Translation Keys
|
||||
|
||||
1. Add key/value in `apps/*/src/messages/en.json`.
|
||||
2. Add equivalent key in `de/es/fr` JSON files.
|
||||
3. Use key via translator:
|
||||
- Web: `useTranslations("Namespace")` or `getTranslations("Namespace")`
|
||||
- Admin: `useAdminT()` or server-side `translateMessage(...)`
|
||||
4. Add/adjust tests for behavior where relevant.
|
||||
|
||||
## Translation Workflow
|
||||
|
||||
1. Author English source copy first.
|
||||
2. Add keys in all supported locales in same change.
|
||||
3. Keep semantic parity across locales.
|
||||
4. Run checks:
|
||||
- `bun run check`
|
||||
- `bun run typecheck`
|
||||
- `bun run test`
|
||||
5. For route-level i18n behavior changes, run e2e smoke:
|
||||
- `bunx playwright test --grep "i18n smoke"`
|
||||
|
||||
## QA Checklist
|
||||
|
||||
- Locale switch persists after refresh.
|
||||
- Page headings and navigation labels translate correctly.
|
||||
- Metadata (`Seo`) strings resolve per locale.
|
||||
- No missing-key placeholders visible in UI.
|
||||
|
||||
## Related Files
|
||||
|
||||
- `apps/web/src/i18n/request.ts`
|
||||
- `apps/web/src/i18n/routing.ts`
|
||||
- `apps/admin/src/i18n/server.ts`
|
||||
- `apps/admin/src/i18n/messages.ts`
|
||||
- `packages/i18n/src/index.ts`
|
||||
@@ -8,7 +8,14 @@ This section covers platform and implementation documentation for engineers and
|
||||
- [Architecture](/architecture)
|
||||
- [Better Auth Baseline](/product-engineering/auth-baseline)
|
||||
- [RBAC And Permissions](/product-engineering/rbac-permission-model)
|
||||
- [i18n Conventions](/product-engineering/i18n-conventions)
|
||||
- [CRUD Examples](/product-engineering/crud-examples)
|
||||
- [Domain Glossary](/product-engineering/domain-glossary)
|
||||
- [Environment Runbook](/product-engineering/environment-runbook)
|
||||
- [Delivery Pipeline](/product-engineering/delivery-pipeline)
|
||||
- [Git Flow Governance](/product-engineering/git-flow-governance)
|
||||
- [Testing Strategy Baseline](/product-engineering/testing-strategy)
|
||||
- [ADR Index](/adr/)
|
||||
- [Workflow](/workflow)
|
||||
|
||||
## Scope
|
||||
@@ -20,6 +27,4 @@ This section covers platform and implementation documentation for engineers and
|
||||
|
||||
## Planned Expansions
|
||||
|
||||
- Domain model and glossary
|
||||
- ADR (Architecture Decision Record) index
|
||||
- Operational playbooks (incident, rollback, recovery)
|
||||
|
||||
43
docs/public-api/glossary.md
Normal file
43
docs/public-api/glossary.md
Normal file
@@ -0,0 +1,43 @@
|
||||
# Public API Glossary
|
||||
|
||||
## Scope
|
||||
|
||||
Baseline terms for future public API design and integration discussions.
|
||||
|
||||
## Terms
|
||||
|
||||
### Public API
|
||||
|
||||
Externally consumable endpoints intended for non-admin clients.
|
||||
|
||||
### Resource
|
||||
|
||||
Entity exposed by an API endpoint (for example: `page`, `media`, `news`).
|
||||
|
||||
### Contract
|
||||
|
||||
The stable request/response schema for an endpoint version.
|
||||
|
||||
### Version
|
||||
|
||||
Compatibility boundary for API contracts (for example: `v1`).
|
||||
|
||||
### Authentication
|
||||
|
||||
Identity verification mechanism for protected API routes.
|
||||
|
||||
### Authorization
|
||||
|
||||
Permission check determining whether an authenticated actor can access a resource/action.
|
||||
|
||||
### Pagination
|
||||
|
||||
Mechanism for splitting large result sets across requests.
|
||||
|
||||
### Idempotency
|
||||
|
||||
Property where repeating a request does not change final state beyond the first successful call.
|
||||
|
||||
### Rate Limit
|
||||
|
||||
Request threshold policy applied per consumer/time window.
|
||||
@@ -11,6 +11,11 @@ No stable public API surface is documented yet.
|
||||
- Add API docs when real endpoints are implemented and versioned
|
||||
- Use OpenAPI as source of truth for endpoint reference
|
||||
- Keep integration guides and authentication examples here
|
||||
- Use glossary terms consistently across API specs and guides
|
||||
|
||||
## Reference
|
||||
|
||||
- [Public API Glossary](/public-api/glossary)
|
||||
|
||||
## Notes
|
||||
|
||||
|
||||
@@ -28,3 +28,9 @@ Follow `BRANCHING.md`:
|
||||
```bash
|
||||
bun run changelog:release
|
||||
```
|
||||
|
||||
## Governance
|
||||
|
||||
- Branch and PR governance checks run in `.gitea/workflows/ci.yml`.
|
||||
- PR template: `.gitea/PULL_REQUEST_TEMPLATE.md`
|
||||
- Versioning policy: `VERSIONING.md`
|
||||
|
||||
@@ -1,10 +1,13 @@
|
||||
import { expect, test } from "@playwright/test"
|
||||
|
||||
const BUILD_INFO_PATTERN = /Build v\S+ \+sha\.[a-z0-9]{5,7}/i
|
||||
|
||||
test("smoke", async ({ page }, testInfo) => {
|
||||
await page.goto("/")
|
||||
|
||||
if (testInfo.project.name === "web-chromium") {
|
||||
await expect(page.getByRole("heading", { name: /your next\.js cms frontend/i })).toBeVisible()
|
||||
await expect(page.getByText(BUILD_INFO_PATTERN)).toBeVisible()
|
||||
return
|
||||
}
|
||||
|
||||
@@ -12,6 +15,7 @@ test("smoke", async ({ page }, testInfo) => {
|
||||
|
||||
if (await dashboardHeading.isVisible({ timeout: 2000 })) {
|
||||
await expect(dashboardHeading).toBeVisible()
|
||||
await expect(page.getByText(BUILD_INFO_PATTERN)).toBeVisible()
|
||||
return
|
||||
}
|
||||
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
generator client {
|
||||
provider = "prisma-client"
|
||||
output = "./generated/client"
|
||||
provider = "prisma-client-js"
|
||||
}
|
||||
|
||||
datasource db {
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
import { PrismaPg } from "@prisma/adapter-pg"
|
||||
import { PrismaClient } from "@prisma/client"
|
||||
import { Pool } from "pg"
|
||||
import { PrismaClient } from "../prisma/generated/client/client"
|
||||
|
||||
const connectionString = process.env.DATABASE_URL
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@ import {
|
||||
updatePostInputSchema,
|
||||
} from "@cms/content"
|
||||
import { type CrudAuditHook, type CrudMutationContext, createCrudService } from "@cms/crud"
|
||||
import type { Post } from "../prisma/generated/client/client"
|
||||
import type { Post } from "@prisma/client"
|
||||
|
||||
import { db } from "./client"
|
||||
|
||||
|
||||
Reference in New Issue
Block a user