Add GitHub Actions CI + Windows notes on the developer docs
GitHub had no CI, so naming/tests/build were unenforced on the public mirror. Add .github/workflows/ci.yml mirroring the internal pipeline: backend pytest, the naming gate, frontend vitest+build, and the migrations-mysql job that proves a fresh flask db upgrade + every plugin chain on utf8mb4 MySQL 8 is idempotent. Flip the dev-setup CI note to reflect it. Add an identical Windows/VS Code convention note to the four developer docs (venv\Scripts vs venv/bin, $env: vs export, pointer to DEVELOPMENT-SETUP).
This commit is contained in:
@@ -182,12 +182,12 @@ tasks call `venv/` and `frontend/node_modules`).
|
||||
bash scripts/check-naming-and-style.sh # naming - runs via Git Bash
|
||||
```
|
||||
There is NO auto-installed git hook - you run these yourself (or the
|
||||
VS Code task). On the internal server, CI runs all three on every push
|
||||
and fails the build on a bad name. GitHub Actions is not set up on the
|
||||
public mirror yet, so if you develop against GitHub these local checks
|
||||
(or the opt-in hook below) are your only gate - run them. The naming
|
||||
check is a shell script, so that one line needs Git Bash (installed with
|
||||
Git for Windows).
|
||||
VS Code task). CI runs all three on every push and pull request
|
||||
(`.github/workflows/ci.yml` on GitHub Actions; the same gate runs on the
|
||||
internal server) and fails the build on a bad name, so nothing bad
|
||||
reaches `main` - running them locally just saves the round trip. The
|
||||
naming check is a shell script, so that one line needs Git Bash
|
||||
(installed with Git for Windows).
|
||||
|
||||
Want it automatic? The repo ships a hook; enable it once per clone:
|
||||
```powershell
|
||||
|
||||
@@ -7,6 +7,12 @@ the framework ships a bundled set, and you drop your own plugin into
|
||||
`<framework>/plugins/<name>/` by clone, submodule, or symlink. No pip packaging
|
||||
is required for v1 (pip distribution is deferred to v2 per ADR-003).
|
||||
|
||||
> **Windows / VS Code:** command examples use the Linux venv path
|
||||
> `venv/bin/python`; on Windows use `venv\Scripts\python` and
|
||||
> `$env:FLASK_APP="shopdb"` (not `export`). Full Windows onboarding:
|
||||
> [DEVELOPMENT-SETUP](DEVELOPMENT-SETUP).
|
||||
|
||||
|
||||
If you have not written a plugin before, start with
|
||||
[PLUGIN-QUICKSTART.md](PLUGIN-QUICKSTART.md) and the hook reference in
|
||||
[PLUGIN-HOOKS.md](PLUGIN-HOOKS.md). This document only covers the parts that are
|
||||
|
||||
@@ -5,6 +5,10 @@ running feature with its own list, detail, form, settings page, and report. It i
|
||||
the companion to [PLUGIN-QUICKSTART.md](PLUGIN-QUICKSTART.md): the quickstart gets
|
||||
you moving with `flask plugin new`; this guide explains *why* each piece looks the
|
||||
way it does by walking the shipped code of the exemplar plugin.
|
||||
> **Windows / VS Code:** command examples use the Linux venv path
|
||||
> `venv/bin/python`; on Windows use `venv\Scripts\python` and
|
||||
> `$env:FLASK_APP="shopdb"` (not `export`). Full Windows onboarding:
|
||||
> [DEVELOPMENT-SETUP](DEVELOPMENT-SETUP).
|
||||
|
||||
`measuringtools` was chosen as the exemplar on purpose. It is the first plugin
|
||||
built after the framework matured (ADR-005 scoped it; ADR-008 changed how plugin
|
||||
|
||||
@@ -14,6 +14,12 @@ badge-scanned employee, a touch kiosk (scan bin barcode, scan badge, keypad
|
||||
quantity), 1x0.5in bin labels, low-stock email alerts, and reports. Spec with
|
||||
decision records: `docs/proposals/printedparts-plugin.md`.
|
||||
|
||||
> **Windows / VS Code:** command examples below use the Linux venv path
|
||||
> `venv/bin/python`; on Windows use `venv\Scripts\python` and
|
||||
> `$env:FLASK_APP="shopdb"` (not `export`). Full Windows onboarding:
|
||||
> [DEVELOPMENT-SETUP](DEVELOPMENT-SETUP).
|
||||
|
||||
|
||||
Know before you start
|
||||
- BUNDLED plugin: frontend files live in core `frontend/src/`, and three core
|
||||
files get small edits (api client, sidebar icon map, PLUGIN_TABLE_OWNERS).
|
||||
|
||||
@@ -3,6 +3,12 @@
|
||||
Build a working shopdb-flask plugin in 30 minutes. This walks through generating, customizing, installing, and testing a plugin from scratch.
|
||||
|
||||
For the full hook reference, see [PLUGIN-HOOKS.md](PLUGIN-HOOKS.md).
|
||||
|
||||
> **Windows / VS Code:** command examples below use the Linux venv path
|
||||
> `venv/bin/python`; on Windows use `venv\Scripts\python` and
|
||||
> `$env:FLASK_APP="shopdb"` (not `export`). Full Windows onboarding:
|
||||
> [DEVELOPMENT-SETUP](DEVELOPMENT-SETUP).
|
||||
|
||||
For the architectural decisions behind the contract, see [docs/adr/](../docs/adr/).
|
||||
|
||||
## Step 1: Generate the skeleton
|
||||
|
||||
Reference in New Issue
Block a user