i-plane 1.1.0 → 1.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +9 -0
- package/dist/cli.js +65 -64
- package/docs/api-coverage.md +40 -0
- package/package.json +1 -1
package/docs/api-coverage.md
CHANGED
|
@@ -27,6 +27,46 @@ The compatibility target uses the `issues/` routes. The current public
|
|
|
27
27
|
documents `work-items/` instead. A route migration must be verified against the
|
|
28
28
|
target server; do not change paths solely to match a newer documentation release.
|
|
29
29
|
|
|
30
|
+
## What modules and intake are for
|
|
31
|
+
|
|
32
|
+
A module groups work toward a feature, milestone or other goal and may span
|
|
33
|
+
several cycles. A cycle is a time window. Work items can belong to multiple
|
|
34
|
+
modules. A module's lead and members are separate from work item assignees.
|
|
35
|
+
The module status describes its overall planning stage; work item states show
|
|
36
|
+
individual progress. See [Plane's module guide](https://docs.plane.so/core-concepts/modules).
|
|
37
|
+
|
|
38
|
+
Intake is a queue for reports and requests that have not yet been accepted into
|
|
39
|
+
project work. Requests start in Triage with a pending decision. They can be
|
|
40
|
+
accepted, rejected, snoozed or linked to an existing work item as a duplicate.
|
|
41
|
+
This keeps undecided requests out of committed work. See the
|
|
42
|
+
[intake overview](https://docs.plane.so/intake/overview).
|
|
43
|
+
|
|
44
|
+
| Resource | Plane fields | Current CLI support |
|
|
45
|
+
| --- | --- | --- |
|
|
46
|
+
| Module | Name, description, overall status, start/due dates | `module create` with name, `--description`, `--status`, `--start`, `--due` |
|
|
47
|
+
| Module ownership | Lead and members | Available in the API/UI; not set by this CLI |
|
|
48
|
+
| Module contents | Related work items | `module add`, `module issues`; membership can overlap across modules |
|
|
49
|
+
| Intake request | Title, description, priority | `intake create`; `intake update --name`, `--description`, `--priority` |
|
|
50
|
+
| Intake decision | Pending, rejected, snoozed, accepted, duplicate; snooze deadline; duplicate target | `intake update --status`, `--snooze-until`, `--duplicate-of` |
|
|
51
|
+
| Intake work properties | Assignees, labels, due date and other UI properties | Not exposed by intake commands; use normal `update` after acceptance |
|
|
52
|
+
| Intake channels | In-app submissions, public forms, email | CLI submits through the API; it does not configure forms/email |
|
|
53
|
+
|
|
54
|
+
The UI guide and API defaults are not interchangeable. The module guide says
|
|
55
|
+
new modules start in Backlog, while the tested API instance returned `planned`
|
|
56
|
+
when status was omitted. CLI examples therefore specify `--status planned`.
|
|
57
|
+
The UI can choose a work item state while accepting an intake request; the
|
|
58
|
+
current CLI/API acceptance path moves it to the default project state. A normal
|
|
59
|
+
`update --state` can then select a different state.
|
|
60
|
+
|
|
61
|
+
A focused check of the published CLI confirmed that adding a work item to a
|
|
62
|
+
second module preserves its first membership, and that intake acceptance moves
|
|
63
|
+
a request from pending/Triage into the normal Backlog state on the tested
|
|
64
|
+
instance. Temporary check data was deleted.
|
|
65
|
+
|
|
66
|
+
Field references: [module creation](https://developers.plane.so/api-reference/module/add-module),
|
|
67
|
+
[intake properties](https://docs.plane.so/core-concepts/intake), and
|
|
68
|
+
[intake updates](https://developers.plane.so/api-reference/intake-issue/update-intake-issue-detail).
|
|
69
|
+
|
|
30
70
|
## Compatibility details
|
|
31
71
|
|
|
32
72
|
Enabling intake on project creation requires a follow-up project PATCH to create
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "i-plane",
|
|
3
|
-
"version": "1.1.
|
|
3
|
+
"version": "1.1.1",
|
|
4
4
|
"description": "CLI \u0434\u043b\u044f Plane \u0441 \u043f\u043b\u043e\u0442\u043d\u044b\u043c \u0432\u044b\u0432\u043e\u0434\u043e\u043c \u043f\u043e\u0434 \u0430\u0433\u0435\u043d\u0442\u0430",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"license": "MIT",
|