@nanobpm/nano-workforce 0.26.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,303 @@
+# Nano Workforce
+
+**Agent Graph Orchestration for Agentic SDLC.** Nano Workforce turns a fleet of
+AI coding agents into a durable, self-driving software-delivery workforce: hand it
+an issue and it plans the work, fans a graph of agents out to implement it, drives
+every resulting pull request to **review convergence** against an automated
+reviewer, and **merges** it — escalating to a human only when an agent is stuck or
+a round cap is hit.
+
+It is a [Nano](https://github.com/jwulf/nano-ide) **Urban app**: a set of durable
+BPMN processes (`resources/processes/*.bpmn`) executed by the Nano engine, with the
+orchestration graph — planning, implementation, review, and merge — modelled
+explicitly so the whole lifecycle survives restarts, latency, and failure.
+
+- **Plan → implement** — a planning agent decomposes an issue into levelized tasks;
+  a parallel fan-out drives one implementation agent per task, one PR each.
+- **Review convergence** — each PR runs a durable multi-round loop against an
+  automated reviewer until it converges (or escalates).
+- **Merge** — a converged PR flows into a merge loop that clears dependencies,
+  auto-fixes failing CI, and merges (queue-aware), escalating conflicts.
+
+The agents are external workers you "hire" (any coding-agent CLI harness, e.g. the
+GitHub Copilot CLI). Nano Workforce owns the orchestration; the agents do the work.
+
+---
+
+## Install & run in Nano Studio (recommended)
+
+Nano Workforce ships as a Nano Studio **extension**. Studio installs it from the
+marketplace, scaffolds a project from it, runs it as a first-class app in the left
+rail, and keeps it up to date.
+
+1. **Install the Urban toolkit** (once): Studio → **Extensions** → search
+   `@nanobpm/nano-ide-app-urban` → **Install**. This provides the `urban` runtime/CLI
+   that every Urban app builds on. (Studio installs it automatically the first time
+   you create an Urban project.)
+
+2. **Install Nano Workforce**: Studio → **Extensions** → search
+   `@nanobpm/nano-workforce` (or browse the **Agentic SDLC** category) → **Install**.
+
+3. **Create a project**: Studio → **New Project** → pick **Nano Workforce** →
+   name it → **Create**. Studio copies the app into your workspace and records the
+   version it was scaffolded from.
+
+4. **Configure**: in the project's settings, set at least `GITHUB_TOKEN` and, if the
+   engine isn't at the default, `NANOBPMN_BASE_URL` (or `CAMUNDA_REST_ADDRESS`). See
+   [Configuration](#configuration).
+
+5. **Run**: press **Run**. The app starts, deploys its BPMN, hosts its record
+   workers, and appears in the **left rail** as **Nano Workforce** with its embedded
+   UI (submit a PR, hand over an issue, answer escalations). Stop/Restart from the
+   same pane.
+
+6. **Hire agents**: the orchestration is running, but it needs agents to do the
+   engineering. See [Hire your agents](#hire-your-agents).
+
+### Updating an installed project
+
+When a new version of the extension is published, Studio flags the project with an
+**"Update available"** badge. Click it to review the change, then **Apply**:
+
+- Studio does a **three-way merge** against the version you originally scaffolded
+  from — new files are added, files only the app changed are updated, and files you
+  and the app both changed are auto-merged where they don't overlap.
+- **Conflicts** (a file you and the new version both edited in the same place) are
+  listed and **left for you to resolve** — nothing is clobbered silently.
+- Your **data is never touched**: `app.db` (and its WAL/SHM), `node_modules`,
+  `.git`, and generated dirs are always preserved. The runtime re-applies
+  `db/migrations` on the next boot, so your PRs/rounds/escalations survive the update.
+
+Preview first with a dry-run (Studio shows the plan — created / overwritten /
+merged / conflicting — before writing anything).
+
+---
+
+## Run from the CLI (second-class)
+
+You can also run Nano Workforce directly, outside Studio, against a running Nano
+engine. This is the second-class path — no left-rail integration or update UI — but
+it's the same app and the same behaviour.
+
+### Prerequisites
+
+- A running **Nano gateway/engine** (default `http://localhost:8080`) — what the app
+  deploys to and what agents pull jobs from.
+- **[Node](https://nodejs.org/) >= 22.6** (the app hosts on Node built-ins;
+  `@nanobpm/urban` declares `engines.node >=22.6`). **[Deno](https://deno.land/)** is
+  optional (only for `npm run compile`).
+- The **c8ctl CLI with the `nano` plugin** (to hire/run agents).
+- On each agent host: the **GitHub CLI** logged in (`gh auth login`) or a
+  `GITHUB_TOKEN`/`GH_TOKEN` in the environment, plus the agent harness itself (e.g.
+  the [Copilot CLI](https://github.com/github/copilot-cli)).
+
+### Install, configure, run
+
+```sh
+npm install
+
+export CAMUNDA_REST_ADDRESS=http://localhost:8080/v2   # or NANOBPMN_BASE_URL=http://localhost:8080
+export GITHUB_TOKEN=ghp_...                             # for the review poller / merge
+export PR_REVIEW_PORT=3000                              # app HTTP port (default 3000)
+
+npm start        # → http://localhost:3000
+# or, via the urban CLI:
+urban run        # `urban gen` then run
+```
+
+That deploys the processes, starts the app-hosted record workers, serves the web UI,
+and runs the review-ready poller.
+
+### Upgrade a CLI install
+
+```sh
+npm run upgrade                              # dry-run against @latest
+npm run upgrade -- --apply                   # apply the overlay, preserving app.db
+npm run upgrade -- --version 0.26.0 --apply  # pin a specific version
+npm run upgrade -- --from ./pkg.tgz --apply  # from a local tarball (offline)
+```
+
+The upgrade overlays the new pack's files, preserves your `app.db`/`node_modules`/
+`.git`/generated dirs, and reports what changed. Reinstall deps if `package.json`
+changed, then restart — migrations re-apply on boot, keeping your data.
+
+---
+
+## Hire your agents
+
+An agent is a CLI harness (the Copilot CLI here) turned into a Nano job worker. Hire a
+profile whose **rank + capabilities** subscribe it to the `senior:*` job types the
+app emits, then put it to work:
+
+```sh
+c8ctl nano hire \
+  --name fleet \
+  --rank senior \
+  --capabilities pr-review plan plan-review feature fix-ci \
+  --command 'copilot -p - --allow-all-tools' \
+  --model <your-model>
+
+c8ctl nano work fleet         # polls every senior:* agent task below until Ctrl-C
+```
+
+`--rank senior` × those five capabilities subscribes the worker to exactly the agent
+task types the three workflows emit (one `senior:<capability>` job type per
+capability):
+
+| Capability | Job type | Workflow | Task |
+| --- | --- | --- | --- |
+| `pr-review` | `senior:pr-review` | `convergence-loop` | Review round (drive a PR to convergence) |
+| `plan` | `senior:plan` | `plan-fanout` | Plan an issue into levelized tasks |
+| `plan-review` | `senior:plan-review` | `plan-fanout` | Review the plan before fan-out |
+| `feature` | `senior:feature` | `plan-fanout` | Implement one planned task → open a PR |
+| `fix-ci` | `senior:fix-ci` | `merge-loop` | Green a `blocked` PR's failing checks |
+
+- `--command 'copilot -p - --allow-all-tools'` starts the Copilot CLI reading its
+  prompt from **stdin** (`-p -`). The harness pipes the whole job JSON (prompt +
+  `job.variables`) to stdin; the relevant `prompts/*.md` template tells the agent how
+  to read it and where to write its result.
+- **`--allow-all-tools` is essential** for an unattended worker — without it Copilot
+  pauses for permission before each tool call and the job stalls.
+
+  > ⚠️ **Only enable `--allow-all-tools` for code and hosts you trust.** It grants the
+  > agent broad unattended permissions (shell, file writes, network). Each job runs in
+  > a throwaway per-job workspace, but the worker still runs as your user on the host.
+  > Use `--deny-tool` to narrow it, or a container sandbox for stronger isolation.
+
+Run a **second** worker (another terminal or machine) and they alternate across
+whichever PRs/tasks are ready — that is the idle time you reclaim. Run more than one
+job per worker with `--max-parallel 2`. The app-hosted `pr.*` workers (record-plan,
+select-wave, finalize, merge, …) run **inside** the app, not on an agent worker.
+
+Already have a narrower worker? Extend it in place instead of re-hiring — `c8ctl nano
+assign <name> plan plan-review feature fix-ci` unions the roles onto the profile,
+then restart its worker.
+
+---
+
+## What it does
+
+### Submit a PR → review convergence
+
+Submit a PR (from the UI as `owner/repo#123` or a PR URL, the API, or the webhook) and
+one durable `convergence-loop` starts. Each round dispatches a `senior:pr-review`
+agent; between rounds the process **parks on a durable message-catch event**, so agent
+slots and job timeouts are never held hostage to review latency. The poller watches
+GitHub and publishes `review-ready` when a new review lands (no webhook needed — works
+behind NAT).
+
+```
+ submit (UI / webhook) ──► convergence-loop (BPMN)
+                              │  converged ──► finalize ──► (merge stage)
+   Review round (agent) ──────┼  addressed ──► record ──► wait review-ready ─┐
+   taskType senior:pr-review  └  needs_input/blocked ─► escalate ─► wait ────┤
+        ▲                                              escalation-answered   │
+        └──────────────────────── loop ───────────────────────────────────  ┘
+```
+
+### Merge stage
+
+With `NANO_PR_AUTO_MERGE` on (default), a converged PR flows into `merge-loop`: it
+parks until any `Depends-on:` PRs have landed, arms the merge, auto-detects a merge
+queue (waits for landing) vs a straight squash/merge/rebase, and — on a `blocked`
+verdict (a required check failed) — dispatches a `senior:fix-ci` agent to green the
+branch before escalating (`NANO_PR_MAX_CI_FIX_ROUNDS`, default 3). Conflicts, an
+exhausted budget, or an agent that can't fix the build escalate to a human; answer in
+the UI and the process re-arms and retries.
+
+### Fleet mode: hand it an issue (plan → implement → converge)
+
+```
+ issue (UI / POST /hooks/plan) ─► plan-fanout (BPMN)
+    plan (senior:plan) ─► record-plan ─► implement × N (parallel, senior:feature) ─► record-results
+                                                                                       │
+                                          each opened PR ──► convergence-loop (above)
+```
+
+A planning agent decomposes the issue into tasks; a parallel multi-instance activity
+fans them out over implementation agents (one PR per task); `record-results` enrols
+every opened PR into the convergence loop. Submit from the **"Hand an issue to the
+fleet"** form, or:
+
+```bash
+curl -sS -X POST http://localhost:3000/hooks/plan \
+  -H 'content-type: application/json' \
+  -H "x-hook-secret: $NANO_PR_WEBHOOK_SECRET" \
+  -d '{ "issue": "owner/repo#123" }'
+```
+
+---
+
+## Configuration
+
+| env | default | purpose |
+|---|---|---|
+| `PR_REVIEW_PORT` | `3000` | app HTTP port |
+| `NANO_APP_DB_URL` | `file:./app.db` | sqlite datasource |
+| `NANOBPMN_BASE_URL` | `http://localhost:8080` | engine base URL (or set `CAMUNDA_REST_ADDRESS` to the `/v2` REST address directly) |
+| `GITHUB_TOKEN` | — | token for the review poller / merge (or use the host `gh` CLI) |
+| `NANO_PR_GITHUB_TRANSPORT` | `auto` | how the poller reads GitHub: `gh` (host CLI), `token` (`GITHUB_TOKEN` over HTTP), or `auto` |
+| `NANO_PR_POLL_MS` | `60000` | review-ready poll interval |
+| `NANO_PR_MAX_ROUNDS` | `20` | default cap: escalate after N rounds (per-submit override via the form / webhook `maxRounds`; clamped 1–100) |
+| `NANO_PR_WEBHOOK_SECRET` | — | shared secret for `POST /hooks/submit` (`X-Hook-Secret`) |
+| `NANO_PR_AUTO_MERGE` | `1` | after convergence, run the merge stage; `0` = stop at `converged` (review-only) |
+| `NANO_PR_MERGE_METHOD` | `squash` | merge method: `squash`, `merge`, or `rebase` |
+| `NANO_PR_MERGE_ADMIN` | `0` | pass `--admin` to override failing non-required checks (use with care) |
+| `NANO_PR_MAX_CI_FIX_ROUNDS` | `3` | max `senior:fix-ci` attempts to green a `blocked` PR before escalating; `0` disables (escalate immediately), clamped 0–20 |
+| `NANO_PR_REVIEW_WAIT_TIMEOUT` | `PT20M` | ISO-8601 duration the loop waits for a fresh review before escalating a stalled review (timer arm of the `wait-review` gateway) |
+| `NANO_PR_REVIEW_NUDGE_MINUTES` | `5` | cooldown between the poller's automatic reviewer re-request nudges for one waiting PR (clamped 1–1440) |
+
+### Purge
+
+The app keeps its own SQLite state (PRs/rounds/escalations) separate from the engine.
+When you purge and restart the engine, wipe the app db too so they stay consistent:
+
+```sh
+npm run purge   # deletes app.db (+ WAL/SHM) and re-applies db/migrations
+```
+
+---
+
+## The agents (external workers)
+
+The `senior:*` tasks are serviced by **external** workers — they are **not** in the
+manifest `workers[]`. Point a `c8ctl nano work` daemon (or any Zeebe-style worker) at
+the task types; each job carries its variables (e.g. `senior:pr-review` gets `{prUrl,
+repo, prNumber, round, answer?}` and returns `{status, summary, question?}`). An
+agent's base prompt is **not** in the job payload — it is delivered via a model
+**template header** (`{{review-round}}`, `{{plan}}`, `{{feature}}`, `{{fix-ci}}`, …)
+substituted at deploy time from `prompts/*.md` (`models.templates` in `nano.app.json`);
+per-instance context (e.g. a human's escalation answer) is appended by the harness.
+
+---
+
+## Compile to a native binary
+
+The app is authored on Node built-ins, so **Deno** can cross-compile it into a native
+executable that bundles the runtime, deps, and entry code (the target box needs no
+Node/Deno/`node_modules`):
+
+```sh
+npm run compile   # → dist/nano-workforce  (via deno compile)
+```
+
+> **Not yet a single self-contained file.** The binary bundles the runtime + deps +
+> entry code, but the Urban runtime loads the app's declarative files
+> (`nano.app.json`, `pages/`, `db/migrations/`, `prompts/`, `resources/`, and the
+> `actions/`/`workers/` modules) from the **working directory at runtime** — so ship
+> the binary alongside those app files and run it from that directory. Add `--target`
+> in the `deno.json` `compile` task to cross-compile for another OS/arch.
+
+---
+
+## Architecture & contributing
+
+- **[SPEC.md](SPEC.md)** — the behavioural source of truth for the processes.
+- **[AGENTS.md](AGENTS.md)** — the operational guide for anyone (human or AI) making
+  changes: engineering principles, the BPMN authoring rules (author the semantic
+  model, **generate** the diagram — CI enforces DI freshness), migration policy, and
+  the CI gates.
+
+## License
+
+Apache-2.0 — see [LICENSE](LICENSE).