8ae47feeff
Requested: no more Android building, focus on the Docker app build and the web app. android-apk.yml also ran on every push to every branch, so every commit started an APK build beside the one workflow anyone was watching. Worse, its runner — ped-ai-android-runner — advertises the same forgejo-local label as the general runner, so it was also picking up the Docker build job and dying instantly with "'runs-on' key not defined". That is why docker-build showed a failure next to a success on the same commit. Removed: .forgejo/workflows/android-apk.yml, and the two GitHub APK workflows, which never ran at all — there is no GitHub remote on this repo, only forgejo. The Capacitor project under mobile/ is untouched and still builds by hand; docs/mobile-build.md now says plainly that nothing builds it for you. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Dv6sqaY6Vq3ChZHMem3cnU
53 lines
1.5 KiB
Markdown
53 lines
1.5 KiB
Markdown
# Contributing
|
|
|
|
<!-- Pipeline verified 2026-04-15: auto-version + PAT + multi-arch docker -->
|
|
|
|
## Commit format
|
|
|
|
[Conventional Commits](https://www.conventionalcommits.org). `.github/workflows/auto-version.yml`
|
|
parses messages since the last semver tag and decides whether to bump.
|
|
|
|
| Prefix | Bump | |
|
|
|---|---|---|
|
|
| `fix:` | patch | bug fix |
|
|
| `feat:` | minor | new feature |
|
|
| `feat!:` / `fix!:` / `BREAKING CHANGE:` in body | major | breaking change |
|
|
| `docs:` `refactor:` `chore:` `test:` `style:` `ci:` `build:` | none | no release |
|
|
|
|
Append `[skip ci]` to suppress the run for that commit.
|
|
|
|
## Manual release
|
|
|
|
```bash
|
|
scripts/release.sh 6.2.0 --push # local
|
|
```
|
|
|
|
or Actions tab → **Version bump & release** → Run workflow → pick bump type.
|
|
|
|
## What a tag push triggers
|
|
|
|
| Workflow | Output |
|
|
|---|---|
|
|
| `docker-publish.yml` | `danielonyejesi/pediatric-ai-scribe-v3:{version,latest}` on Docker Hub (amd64) |
|
|
|
|
## Local dev
|
|
|
|
```bash
|
|
docker compose up -d # Postgres + app
|
|
docker logs -f pediatric-ai-scribe
|
|
```
|
|
|
|
Web changes hot-reload via browser refresh (JS/CSS cached 1h — add `?v=` query
|
|
or clear cache; the build-ID server-side cache-buster appends `?v=<git SHA>`
|
|
automatically on fresh page loads).
|
|
|
|
Server code changes require `./scripts/build-image.sh && docker compose up -d --no-build`.
|
|
|
|
## Mobile
|
|
|
|
See `docs/mobile-build.md`.
|
|
|
|
## DB migrations
|
|
|
|
`src/db/database.js` is the baseline (idempotent CREATE-IF-NOT-EXISTS). New
|
|
changes go in `migrations/` via `node-pg-migrate`. See `docs/migrations.md`.
|