{"_id":"@amykit/workflow-note-to-plan","_rev":"4-68186fe8d257a1504abc257cf1712bee","name":"@amykit/workflow-note-to-plan","dist-tags":{"latest":"0.4.0"},"versions":{"0.2.0":{"name":"@amykit/workflow-note-to-plan","version":"0.2.0","author":{"name":"Nicolas Melo"},"license":"MIT","_id":"@amykit/workflow-note-to-plan@0.2.0","maintainers":[{"name":"amykit","email":"nicolasmelo12+amykit@gmail.com"}],"homepage":"https://github.com/nicolasmelo1/amy#readme","bugs":{"url":"https://github.com/nicolasmelo1/amy/issues"},"dist":{"shasum":"f4a696be1e7142c0e886b80447c9ba845a56f8e7","tarball":"https://registry.npmjs.org/@amykit/workflow-note-to-plan/-/workflow-note-to-plan-0.2.0.tgz","fileCount":54,"integrity":"sha512-R+NugJpechzgR8KwVXdjxRRkSuTVpTWcrknY3T3tHUkCSWx9LEkSCq8j9ILOshLfNpuL3L/VP47pxmQr39wX0g==","signatures":[{"sig":"MEQCIDJr9KZBPU/7iqeZkja/9/V04raMt+51kg2m76uQuRUBAiBsZ5/Mm2KXGiwh0vSN9xY70zM228/E02TISDZpPcFOug==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"attestations":{"url":"https://registry.npmjs.org/-/npm/v1/attestations/@amykit%2fworkflow-note-to-plan@0.2.0","provenance":{"predicateType":"https://slsa.dev/provenance/v1"}},"unpackedSize":67512},"main":"./dist/index.js","type":"module","types":"./dist/index.d.ts","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js"}},"gitHead":"b7903f5c95e8154f5db6fd4df6ca2633a628812d","_npmUser":{"name":"amykit","email":"nicolasmelo12+amykit@gmail.com"},"repository":{"url":"git+https://github.com/nicolasmelo1/amy.git","type":"git","directory":"packages/workflow-note-to-plan"},"_npmVersion":"11.19.0","description":"The note-to-plan workflow: friction becomes a plan in the repository it is about.","directories":{},"_nodeVersion":"24.20.0","dependencies":{"@amykit/core":"^0.2.0"},"publishConfig":{"access":"public","registry":"https://registry.npmjs.org"},"_hasShrinkwrap":false,"devDependencies":{"@amykit/test-fixtures":"^0.1.0"},"_npmOperationalInternal":{"tmp":"tmp/workflow-note-to-plan_0.2.0_1788658146970_0.12225295462358421","host":"s3://npm-registry-packages-npm-production"}},"0.3.0":{"name":"@amykit/workflow-note-to-plan","version":"0.3.0","author":{"name":"Nicolas Melo"},"license":"MIT","_id":"@amykit/workflow-note-to-plan@0.3.0","maintainers":[{"name":"amykit","email":"nicolasmelo12+amykit@gmail.com"}],"homepage":"https://github.com/nicolasmelo1/amy#readme","bugs":{"url":"https://github.com/nicolasmelo1/amy/issues"},"dist":{"shasum":"ffe931145a832bb1c277549b8ad0a2dc8dd8fd70","tarball":"https://registry.npmjs.org/@amykit/workflow-note-to-plan/-/workflow-note-to-plan-0.3.0.tgz","fileCount":54,"integrity":"sha512-tyENO9a1LaymP3qIZiNzMxc+zcjnOM39mGPGrLRVSFo2edM1YxXWW8JR2oePRhz/KjyQk7nHuiI663rvgr7asQ==","signatures":[{"sig":"MEUCIQCv3nUrYRG0bUX1OiFTvzA3+MlCUjdupL2n/G0QEgy2jAIgZTqTLmRmkcTRdmVgOd7MKyhfsBr4dSMzSsQyRijlfXI=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"attestations":{"url":"https://registry.npmjs.org/-/npm/v1/attestations/@amykit%2fworkflow-note-to-plan@0.3.0","provenance":{"predicateType":"https://slsa.dev/provenance/v1"}},"unpackedSize":67512},"main":"./dist/index.js","type":"module","types":"./dist/index.d.ts","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js"}},"gitHead":"a9e241e87a00d8267ad9e992c4ab8fd97bd04480","_npmUser":{"name":"amykit","email":"nicolasmelo12+amykit@gmail.com"},"repository":{"url":"git+https://github.com/nicolasmelo1/amy.git","type":"git","directory":"packages/workflow-note-to-plan"},"_npmVersion":"11.19.0","description":"The note-to-plan workflow: friction becomes a plan in the repository it is about.","directories":{},"_nodeVersion":"24.20.0","dependencies":{"@amykit/core":"^0.3.0"},"publishConfig":{"access":"public","registry":"https://registry.npmjs.org"},"_hasShrinkwrap":false,"devDependencies":{"@amykit/test-fixtures":"^0.1.0"},"_npmOperationalInternal":{"tmp":"tmp/workflow-note-to-plan_0.3.0_1788922128750_0.25198988374343223","host":"s3://npm-registry-packages-npm-production"}},"0.3.1":{"name":"@amykit/workflow-note-to-plan","version":"0.3.1","author":{"name":"Nicolas Melo"},"license":"MIT","_id":"@amykit/workflow-note-to-plan@0.3.1","maintainers":[{"name":"amykit","email":"nicolasmelo12+amykit@gmail.com"}],"homepage":"https://github.com/nicolasmelo1/amy#readme","bugs":{"url":"https://github.com/nicolasmelo1/amy/issues"},"dist":{"shasum":"ac0c19f1b3f9a2bef79068f860ae1b38d03f3711","tarball":"https://registry.npmjs.org/@amykit/workflow-note-to-plan/-/workflow-note-to-plan-0.3.1.tgz","fileCount":54,"integrity":"sha512-jQ4WOIacfes6kpior2nGwjOZtqKK9pes9x0rZu1dLFN9GYrtnnqxTEfIqFQODKB+rkC2V37JDkJTzmpVwzChsQ==","signatures":[{"sig":"MEUCIQDidOlW6tt7l8zfayNKSixwGXUgGK4KeZYoPTRiKHdvRwIgf5Z6N2lXPBlM1Kzj81nEVMcaIyS5fogFULWVxDvEFXk=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"attestations":{"url":"https://registry.npmjs.org/-/npm/v1/attestations/@amykit%2fworkflow-note-to-plan@0.3.1","provenance":{"predicateType":"https://slsa.dev/provenance/v1"}},"unpackedSize":67512},"main":"./dist/index.js","type":"module","types":"./dist/index.d.ts","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js"}},"gitHead":"6a4c559ad368c51e232a33c4c2221f02709ceb2f","_npmUser":{"name":"amykit","email":"nicolasmelo12+amykit@gmail.com"},"repository":{"url":"git+https://github.com/nicolasmelo1/amy.git","type":"git","directory":"packages/workflow-note-to-plan"},"_npmVersion":"11.19.0","description":"The note-to-plan workflow: friction becomes a plan in the repository it is about.","directories":{},"_nodeVersion":"24.20.0","dependencies":{"@amykit/core":"^0.3.1"},"publishConfig":{"access":"public","registry":"https://registry.npmjs.org"},"_hasShrinkwrap":false,"devDependencies":{"@amykit/test-fixtures":"^0.1.0"},"_npmOperationalInternal":{"tmp":"tmp/workflow-note-to-plan_0.3.1_1788973008839_0.45575535330224337","host":"s3://npm-registry-packages-npm-production"}},"0.4.0":{"_id":"@amykit/workflow-note-to-plan@0.4.0","bugs":{"url":"https://github.com/nicolasmelo1/amy/issues"},"dist":{"shasum":"af8507f696a0a45b2f06a45c837d158a88ca3d18","tarball":"https://registry.npmjs.org/@amykit/workflow-note-to-plan/-/workflow-note-to-plan-0.4.0.tgz","fileCount":54,"integrity":"sha512-MTHN3cJJsHSbh/GOrhfX5dV9bf3ezeiN3GElSC0lsdA/BgBY8ysASHwoseDDcawXC5W9oiRvHN/IEAFSy230dQ==","signatures":[{"sig":"MEQCIHr2h4k4uePgY4Z/Vh/PoVMyS8SfE/j2ecDdXJw5gtVNAiAsYFSno2VAA+WCfT/5Svn04EWSllGBSw4KGEDwvFX14A==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"},{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEQCIDoqql7lPcQxt3i3uJiKIIJDFt1UMCq9SDbdpGEuuIIJAiAhwhis64TTUPuP1QRtgBdMkp+CoePReY1QZkBtMvZkhQ=="}],"attestations":{"url":"https://registry.npmjs.org/-/npm/v1/attestations/@amykit%2fworkflow-note-to-plan@0.4.0","provenance":{"predicateType":"https://slsa.dev/provenance/v1"}},"unpackedSize":69926},"main":"./dist/index.js","name":"@amykit/workflow-note-to-plan","type":"module","types":"./dist/index.d.ts","author":{"name":"Nicolas Melo"},"exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js"}},"gitHead":"ac437aba051bd8e109e1eb8b3c32b0365c6b4e2e","license":"MIT","version":"0.4.0","_npmUser":{"name":"amykit","email":"nicolasmelo12+amykit@gmail.com"},"homepage":"https://github.com/nicolasmelo1/amy#readme","repository":{"url":"git+https://github.com/nicolasmelo1/amy.git","type":"git","directory":"packages/workflow-note-to-plan"},"_npmVersion":"11.19.0","description":"The note-to-plan workflow: friction becomes a plan in the repository it is about.","directories":{},"maintainers":[{"name":"amykit","email":"nicolasmelo12+amykit@gmail.com"}],"_nodeVersion":"24.20.0","dependencies":{"@amykit/core":"^0.4.0"},"publishConfig":{"access":"public","registry":"https://registry.npmjs.org"},"_hasShrinkwrap":false,"devDependencies":{"@amykit/test-fixtures":"^0.1.0"},"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/workflow-note-to-plan_0.4.0_1789739871180_0.508099293821179"}}},"time":{"created":"2026-09-06T01:29:06.810Z","modified":"2026-09-18T13:57:51.650Z","0.2.0":"2026-09-06T01:29:07.126Z","0.3.0":"2026-09-09T02:48:48.908Z","0.3.1":"2026-09-09T16:56:48.984Z","0.4.0":"2026-09-18T13:57:51.278Z"},"bugs":{"url":"https://github.com/nicolasmelo1/amy/issues"},"author":{"name":"Nicolas Melo"},"license":"MIT","homepage":"https://github.com/nicolasmelo1/amy#readme","repository":{"url":"git+https://github.com/nicolasmelo1/amy.git","type":"git","directory":"packages/workflow-note-to-plan"},"description":"The note-to-plan workflow: friction becomes a plan in the repository it is about.","maintainers":[{"name":"amykit","email":"nicolasmelo12+amykit@gmail.com"}],"readme":"<!-- Generated by `npm run docs:generate` from the package itself. Do not edit by hand. -->\n\n# @amykit/workflow-note-to-plan\n\nThe note-to-plan workflow: friction becomes a plan in the repository it is about.\n\nA workflow for [amy](https://github.com/nicolasmelo1/amy): a pure `plan()` that says what\nhappens next, and a runtime that says how each step is done. The engine drives it without\nknowing what any of its states mean.\n\n## Install\n\n```sh\nnpm install -g @amykit/workflow-note-to-plan\n```\n\nThen name it in `~/.amy/config.yaml`:\n\n```yaml\nworkflows:\n  note-to-plan:\n    workflow: \"@amykit/workflow-note-to-plan\"\n```\n\n## The lifecycle\n\n| State | Kind |\n| :-- | :-- |\n| `NOTED` | initial, waiting |\n| `DRAFTED` | working |\n| `CHECKED` | working |\n| `PR_OPEN` | working |\n| `DONE` | terminal |\n| `DECLINED` | terminal |\n\nIt emits `announce`, `check-plan`, `draft-plan` and `open-pull-request`.\n\n## Configuration\n\n```yaml\nplugins:\n  \"@amykit/workflow-note-to-plan\":\n    baseBranch: {}\n    defaultBranch: \"main\"\n    policy: {}\n    repos: <string[]>\n```\n\n| Setting | Type | Required | Default | What it is |\n| :-- | :-- | :-- | :-- | :-- |\n| `baseBranch` | `record` | no | `{}` | where one repository's base branch is, instead of the fallback. A repository named here has its plan opened against that branch |\n| `defaultBranch` | `string` | no | `main` | the branch a plan branch is cut from, which is not always `main` |\n| `policy` | `record` | no | `{}` | maxDraftAttempts, maxOpenPlansPerRepo and ceilingBackoffMs. Anything left out keeps its default |\n| `repos` | `string[]` | **yes** |  | the repositories a plan may be written into. A note about anything else is handed back to the operator |\n\nEvery field is checked at boot against the schema this package declares. A key that is\nnot one of the above is a refusal naming the plugin and the key, not a setting that\nsilently never applied.\n\n## Where the reasoning is\n\n- [Writing a workflow](https://github.com/nicolasmelo1/amy/tree/main/docs/build/write-a-workflow.md)\n- [Reference: workflows](https://github.com/nicolasmelo1/amy/tree/main/docs/reference/workflows.md)\n- [Ports and the registry](https://github.com/nicolasmelo1/amy/tree/main/docs/concepts/ports.md)\n\n## Licence\n\nMIT\n","readmeFilename":"README.md"}