create-filegrc 0.9.2 → 0.10.0
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/package.json
CHANGED
package/src/index.js
CHANGED
|
@@ -523,13 +523,13 @@ async function runCombinedSetup(target, input) {
|
|
|
523
523
|
async function writeMinimalLockfile(target, name, versionRange) {
|
|
524
524
|
const lock = {
|
|
525
525
|
name,
|
|
526
|
-
version: "0.
|
|
526
|
+
version: "0.10.0",
|
|
527
527
|
lockfileVersion: 3,
|
|
528
528
|
requires: true,
|
|
529
529
|
packages: {
|
|
530
530
|
"": {
|
|
531
531
|
name,
|
|
532
|
-
version: "0.
|
|
532
|
+
version: "0.10.0",
|
|
533
533
|
dependencies: { filegrc: versionRange }
|
|
534
534
|
}
|
|
535
535
|
}
|
package/template/AGENTS.md
CHANGED
|
@@ -57,7 +57,7 @@ Read `data/AGENTS.md` before changing records. More specific instructions inside
|
|
|
57
57
|
|
|
58
58
|
The JSON and Markdown under `data/`, the installed model, policy content, and Git history are the inputs to FileGRC’s shared workflow calculation. Source files hold facts, decisions, relationships, dates, status, and evidence references. They do not each need a copy of the generic audit-readiness instructions or calculated TODO list.
|
|
59
59
|
|
|
60
|
-
Use `npx filegrc workflow --json`
|
|
60
|
+
Start with `npx filegrc program-path --next --json` for the current step and next action. Use `npx filegrc workflow --json` when you need the complete derived checklist, named readiness assessments, blockers, and Work Items. `guide`, `list --workflow`, `get --workflow`, mutation previews, the HTTP API, and the browser consume the same calculation. Resolve a derived finding by changing its source facts, recording a reviewed applicability decision, accepting an allowed Exception, or completing authoritative assigned work. Never add a separate TODO file or UI-only completion flag for calculated work.
|
|
61
61
|
|
|
62
62
|
FileGRC marks an item `blocked` only when named prerequisite records must be resolved first. A missing record, editable error, or management decision is `ready` when you can act on it now, even when it prevents a readiness assessment from passing.
|
|
63
63
|
|
|
@@ -101,12 +101,12 @@ Do not rewrite or remove committed records that explain prior audit periods. Clo
|
|
|
101
101
|
If the installed CLI reports that this workspace uses an unsupported model, start with:
|
|
102
102
|
|
|
103
103
|
```sh
|
|
104
|
-
npx filegrc migrate --to-model
|
|
104
|
+
npx filegrc migrate --to-model 7 --preview --json
|
|
105
105
|
```
|
|
106
106
|
|
|
107
|
-
Older workspaces migrate one version at a time. Review every preview’s automatic, review-required, and unsupported classifications before applying it with the same options and `--yes`. The
|
|
107
|
+
Older workspaces migrate one version at a time. Review every preview’s automatic, review-required, and unsupported classifications before applying it with the same options and `--yes`. The v7 migration keeps issued historical Audit Documents neutral, returns legacy Training to approved until management records a current activation, and makes old applicability confirmations stale for one scoped review.
|
|
108
108
|
|
|
109
|
-
The [model
|
|
109
|
+
The [model v7 upgrade guide](https://github.com/Alignbase/filegrc/blob/main/docs/upgrading-to-model-v7.md) explains the record-purity change.
|
|
110
110
|
|
|
111
111
|
Run these commands when working with records:
|
|
112
112
|
|
package/template/README.md
CHANGED
|
@@ -19,7 +19,7 @@ npm run serve
|
|
|
19
19
|
|
|
20
20
|
Requires Node.js 20 or newer and Git.
|
|
21
21
|
|
|
22
|
-
Existing model
|
|
22
|
+
Existing model v6 workspaces must run `npx filegrc migrate --to-model 7 --preview --json` after installing a model v7 package. The migration keeps issued historical Audit Documents neutral, returns legacy Training to approved until management records a current activation, and makes old applicability confirmations stale for one scoped review. Older workspaces migrate one model version at a time. See the [model v7 upgrade guide](https://github.com/Alignbase/filegrc/blob/main/docs/upgrading-to-model-v7.md).
|
|
23
23
|
|
|
24
24
|
## How it works
|
|
25
25
|
|
|
@@ -74,8 +74,8 @@ The browser is helpful, but it is not required. An agent can discover the model,
|
|
|
74
74
|
|
|
75
75
|
```sh
|
|
76
76
|
npx filegrc program-path --next --json
|
|
77
|
-
npx filegrc workflow --json
|
|
78
77
|
npx filegrc reconcile --preview --json
|
|
78
|
+
npx filegrc workflow --json # full checklist when needed
|
|
79
79
|
npx filegrc period-health --require-healthy --json
|
|
80
80
|
npx filegrc review-applicability decisions.json --preview --json
|
|
81
81
|
npx filegrc review-collection person --scaffold
|
package/template/data/AGENTS.md
CHANGED
|
@@ -8,16 +8,15 @@ Treat the installed model as the authority. Do not infer a schema from a nearby
|
|
|
8
8
|
|
|
9
9
|
```sh
|
|
10
10
|
npx filegrc guide --json
|
|
11
|
-
npx filegrc workflow --json
|
|
12
|
-
npx filegrc reconcile --preview --json
|
|
13
11
|
npx filegrc program-path --next --json
|
|
12
|
+
npx filegrc reconcile --preview --json
|
|
14
13
|
npx filegrc types --json
|
|
15
14
|
npx filegrc guide RESOURCE_TYPE --json
|
|
16
15
|
npx filegrc list RESOURCE_TYPE --json
|
|
17
16
|
npx filegrc search "TERM" --json
|
|
18
17
|
```
|
|
19
18
|
|
|
20
|
-
Use `workflow --json`
|
|
19
|
+
Use `program-path --next --json` for the current lifecycle step. Use `workflow --json` when you need the full shared assessments, complete checklist, Work Items, and blockers. Use `guide` before any unfamiliar create or status transition. It reports required fields, fields required by a status, enum values, relationship types and candidates, Markdown slots, timing, and exact paths. Use `describe` only when you need the raw model definition.
|
|
21
20
|
|
|
22
21
|
After changing a lifecycle fact directly, review `reconcile --preview --json`. A candidate asks whether the change represents a real policy event. Supply the actual event date or timestamp, departure risk when relevant, and explicit confirmation before applying it.
|
|
23
22
|
|
|
@@ -10,7 +10,7 @@ Set `workflowScope` to `program` for reusable plans, schedules, charters, proced
|
|
|
10
10
|
|
|
11
11
|
Required program Documents follow `draft → approved → active`. Step 2 records the independent approver, `approvedOn`, and the exact `approvedContentRevisions`. After the linked requirements are implemented, Step 3 records `activationBasis: recorded`, the active Person in `activatedByIds`, `activatedOn`, `effectiveOn`, and the unchanged `activatedContentRevisions`. Approval and activation are separate writes even when they happen on the same calendar date. Editing bound Markdown requires a new approval and activation.
|
|
12
12
|
|
|
13
|
-
Engagement Documents use the same separate events inside Step 5. Link each approved or active engagement Document to exactly one Audit, and do not reuse it as a Policy or Obligation document. Activate ready engagement Documents with `npx filegrc activate-documents --audit AUDIT_ID --scaffold`. Approval and activation facts become immutable after their event; return the Document to draft or approved and record a new lifecycle event when the content or decision changes. `activationBasis:
|
|
13
|
+
Engagement Documents use the same separate events inside Step 5. Link each approved or active engagement Document to exactly one Audit, and do not reuse it as a Policy or Obligation document. Activate ready engagement Documents with `npx filegrc activate-documents --audit AUDIT_ID --scaffold`. Approval and activation facts become immutable after their event; return the Document to draft or approved and record a new lifecycle event when the content or decision changes. `activationBasis: historical` is only for an imported historical audit Document whose source did not record approval and activation as separate events. Do not use it for new work.
|
|
14
14
|
|
|
15
15
|
Keep resource links in the Document JSON and supporting records. In the Markdown, describe the underlying business fact in ordinary terms. For example, use “management's control matrix,” “authoritative-source export,” or “signed letter reference” instead of a FileGRC record type or ID.
|
|
16
16
|
|