Skip to content

Commit 344a00d

Browse files
chore(ci): add typecheck step and clarify deploy strategy in README
GitHub Actions are advisory only; docs.kopexa.com is deployed by Coolify on push to main.
1 parent 49a9b74 commit 344a00d

3 files changed

Lines changed: 19 additions & 10 deletions

File tree

.github/workflows/lint.yml

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ permissions:
77

88
jobs:
99
build:
10-
name: Linters
10+
name: Lint & Typecheck
1111
runs-on: ubuntu-latest
1212
timeout-minutes: 15
1313

@@ -36,4 +36,7 @@ jobs:
3636

3737

3838
- name: Lint
39-
run: pnpm lint
39+
run: pnpm lint
40+
41+
- name: Typecheck
42+
run: pnpm typecheck

README.md

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -68,19 +68,23 @@ The container listens on port 3000 and binds to 0.0.0.0. Entry command runs `nod
6868

6969
## Deployment
7070

71-
- Docker standalone image, default `EXPOSE 3000`, listens on `0.0.0.0`.
72-
- Health endpoints for Kubernetes probes:
71+
`docs.kopexa.com` is deployed automatically on every push to `main` by **Coolify** (self-hosted on the Kopexa OVH cluster). Coolify watches this repository, builds the Dockerfile, and rolls the container out. A merge to `main` is sufficient to go live; no GitHub release is required.
72+
73+
The Docker image:
74+
75+
- Standalone Next.js build, `EXPOSE 3000`, listens on `0.0.0.0`
76+
- Health endpoints (used by Coolify):
7377
- Liveness: `GET /api/healthz`
7478
- Readiness: `GET /api/readyz`
75-
- Suitable for GitOps/ArgoCD style deployments.
7679

7780
## CI/CD
7881

79-
- PR checks: `.github/workflows/pr.yml` (lint + build via reusable workflows)
80-
- Release & Docker image: `.github/workflows/release.yml` (builds and publishes to GHCR, then triggers `release-cd.yml`)
81-
- Reusable workflows: `.github/workflows/lint.yml`, `.github/workflows/build.yml`
82-
- Security scan (optional): `.github/workflows/docker-security-scan.yml`
83-
- Versioning: SemVer via GitHub Releases/Tags.
82+
GitHub Actions in this repo are **advisory only**. They give developers fast feedback but do not gate or trigger the production deploy (Coolify does that, see above).
83+
84+
- PR checks: `.github/workflows/pr.yml` runs lint, typecheck and build (`.github/workflows/lint.yml`, `.github/workflows/build.yml`)
85+
- Release Docker image to GHCR (versioned): `.github/workflows/release.yml`, triggered when a GitHub Release is published via release-please
86+
- Security scan: `.github/workflows/docker-security-scan.yml`
87+
- Versioning: SemVer via release-please + GitHub Releases/Tags. The published image at `ghcr.io/kopexa-grc/docs:<version>` exists for downstream consumers; it is **not** what `docs.kopexa.com` runs.
8488

8589
## Contributing
8690

@@ -89,6 +93,7 @@ We welcome fixes and improvements to keep docs accurate and helpful. For larger
8993
- Branch naming: `feat/...`, `fix/...`, `chore/...`, `docs/...`
9094
- Commits: Conventional Commits (e.g., `docs: update spaces guide`)
9195
- Lint/Format: `pnpm lint` and `pnpm format` (Biome)
96+
- Typecheck: `pnpm typecheck` (TypeScript)
9297
- Local tasks: see `Taskfile.dist.yml` (`task dev`, `task lint`, `task docker:build IMAGE_TAG=...`)
9398

9499
## Credits (FOSS)

package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
"build": "next build",
77
"dev": "next dev --turbo",
88
"lint": "biome check",
9+
"typecheck": "tsc --noEmit",
910
"format": "biome format --write",
1011
"start": "next start",
1112
"postinstall": "fumadocs-mdx"

0 commit comments

Comments
 (0)