@connextar/house 0.15.1 → 0.15.2
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 +3 -2
- package/docs/RoutineOperations.md +20 -12
- package/docs/templates/RoutineOperations.md +26 -7
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -589,8 +589,9 @@ for the recurring checks that keep an app ready, aligned and compliant — secur
|
|
|
589
589
|
rounds, release gates, bills, backups, the privacy policy against the code — each
|
|
590
590
|
with when it last ran and when it's next due. An app copies
|
|
591
591
|
[`docs/templates/RoutineOperations.md`](docs/templates/RoutineOperations.md) to its
|
|
592
|
-
own `docs/operations/RoutineOperations.md
|
|
593
|
-
|
|
592
|
+
own `docs/operations/RoutineOperations.md`: a short summary of the method, then its
|
|
593
|
+
own register and run log. Its `AGENTS.md` tells every agent to read the Next due
|
|
594
|
+
column first.
|
|
594
595
|
|
|
595
596
|
### `@connextar/house/changelog`
|
|
596
597
|
|
|
@@ -14,9 +14,15 @@ This document is the method. An app's `docs/operations/RoutineOperations.md` lin
|
|
|
14
14
|
2. **Its run log** — one line for every run (§3, step 5), newest first.
|
|
15
15
|
3. **Its standing go-aheads** — any routine the owner has said may read or write production without asking each time, recorded on that routine's row.
|
|
16
16
|
|
|
17
|
-
|
|
17
|
+
Every app's file has the same three parts, so a reference like "Part 2" means the same thing in each:
|
|
18
18
|
|
|
19
|
-
The method
|
|
19
|
+
- **Part 1 — The method:** a link here and the four rules an agent needs without leaving the file (read Next due first; never write to production without a yes; how a run is recorded; new routines start Proposed, retired ones are paused), with the status keys.
|
|
20
|
+
- **Part 2 — the register:** 2.1 manual routines, 2.2 automated routines, 2.3 paused.
|
|
21
|
+
- **Part 3 — Run log.**
|
|
22
|
+
|
|
23
|
+
Start it from [templates/RoutineOperations.md](templates/RoutineOperations.md): copy it to `docs/operations/RoutineOperations.md`, put the app's name in the title, and fill the register (§5 lists the rows most apps start with). The template links the app's own `docs/operations/ReleaseProcess.md`; an app without one links the shared [ReleaseProcess.md](https://github.com/Connextar/cx-house/blob/main/docs/ReleaseProcess.md) instead. Then add the pointer in §6 to the app's `AGENTS.md`.
|
|
24
|
+
|
|
25
|
+
Part 1 is a summary, not a copy. If the method needs to change, change it here, so every app changes with it, and change the template's Part 1 if one of the four rules moved.
|
|
20
26
|
|
|
21
27
|
---
|
|
22
28
|
|
|
@@ -61,9 +67,9 @@ Every routine has one row, with:
|
|
|
61
67
|
|
|
62
68
|
### How the register is laid out
|
|
63
69
|
|
|
64
|
-
- **Manual routines** — the full table, every field above.
|
|
65
|
-
- **Automated routines** — a shorter table (ID, job, what it does, when, status), headed by a sentence saying where to watch them: the app's job-health page, its operational summary email, its host's cron dashboard. Say how often to look (at least weekly) and when to look sooner.
|
|
66
|
-
- **Paused** — ID, routine, why paused, since.
|
|
70
|
+
- **2.1 Manual routines** — the full table, every field above.
|
|
71
|
+
- **2.2 Automated routines** — a shorter table (ID, job, what it does, when, status), headed by a sentence saying where to watch them: the app's job-health page, its operational summary email, its host's cron dashboard. Say how often to look (at least weekly) and when to look sooner.
|
|
72
|
+
- **2.3 Paused** — ID, routine, why paused, since.
|
|
67
73
|
|
|
68
74
|
---
|
|
69
75
|
|
|
@@ -90,7 +96,7 @@ Every routine has one row, with:
|
|
|
90
96
|
|
|
91
97
|
### Retiring a routine
|
|
92
98
|
|
|
93
|
-
Set it to 🧊 Paused and move it to the Paused table, with the date and the reason. Don't delete it: the run log still points at it, and IDs are never reused.
|
|
99
|
+
Set it to 🧊 Paused and move it to the Paused table (2.3), with the date and the reason. Don't delete it: the run log still points at it, and IDs are never reused.
|
|
94
100
|
|
|
95
101
|
### Booking runs
|
|
96
102
|
|
|
@@ -124,17 +130,19 @@ If continuous integration is switched off, add it to the Paused table with the r
|
|
|
124
130
|
|
|
125
131
|
## 6. The pointer in `AGENTS.md`
|
|
126
132
|
|
|
127
|
-
Add this section to the app's `AGENTS.md`, so every agent reads the register before it starts:
|
|
133
|
+
Add this section to the app's `AGENTS.md`, so every agent reads the register before it starts. Replace the bracketed list with the kinds of check in the app's own register, so an agent knows what it's looking for:
|
|
128
134
|
|
|
129
135
|
```markdown
|
|
130
136
|
## Routine operations
|
|
131
137
|
|
|
132
|
-
- **`docs/operations/RoutineOperations.md` is the register of recurring checks
|
|
138
|
+
- **`docs/operations/RoutineOperations.md` is the register of recurring checks** —
|
|
139
|
+
[security rounds, pruning, release gates, the browser sweep, bills, privacy] —
|
|
133
140
|
with when each last ran and when it's next due. At the start of a task, read its
|
|
134
141
|
**Next due** column: a routine that is due or overdue runs before new feature
|
|
135
142
|
work, or the owner says why not.
|
|
136
|
-
- After running one, record it as the shared method says
|
|
137
|
-
(https://github.com/Connextar/cx-house/blob/main/docs/RoutineOperations.md):
|
|
138
|
-
the full result in its record, a line in the run log, and the row's Last run /
|
|
139
|
-
Add a row in the same change set as anything new that needs
|
|
143
|
+
- After running one, record it as the shared method says (`@connextar/house`'s
|
|
144
|
+
[`docs/RoutineOperations.md`](https://github.com/Connextar/cx-house/blob/main/docs/RoutineOperations.md)):
|
|
145
|
+
the full result in its record, a line in the run log, and the row's Last run /
|
|
146
|
+
Next due / Status. Add a row in the same change set as anything new that needs
|
|
147
|
+
regular attention.
|
|
140
148
|
```
|
|
@@ -1,24 +1,43 @@
|
|
|
1
|
+
<!--
|
|
2
|
+
Copy to docs/operations/RoutineOperations.md and replace "App name".
|
|
3
|
+
The ReleaseProcess.md links assume the app has docs/operations/ReleaseProcess.md.
|
|
4
|
+
If it doesn't, point them at the shared one instead:
|
|
5
|
+
https://github.com/Connextar/cx-house/blob/main/docs/ReleaseProcess.md
|
|
6
|
+
Delete this comment once the file is filled in.
|
|
7
|
+
-->
|
|
8
|
+
|
|
1
9
|
# App name — Routine Operations
|
|
2
10
|
|
|
3
|
-
> The recurring checks that keep App name ready, aligned and compliant: what each one is for, how often it runs, how to run it, when it last ran and what it found, and when it's next due.
|
|
11
|
+
> The recurring checks that keep App name ready, aligned and compliant: what each one is for, how often it runs, how to run it, when it last ran and what it found, and when it's next due. One place to look, so nothing scheduled gets lost in day-to-day work. Sits beside [ReleaseProcess.md](ReleaseProcess.md); [`AGENTS.md`](../../AGENTS.md) points here.
|
|
4
12
|
|
|
5
13
|
_Last updated: YYYY-MM-DD — first version._
|
|
6
14
|
|
|
7
|
-
|
|
15
|
+
This file follows the cohort's method in `@connextar/house`, [`docs/RoutineOperations.md`](https://github.com/Connextar/cx-house/blob/main/docs/RoutineOperations.md). It holds App name's own register (Part 2) and run log (Part 3).
|
|
16
|
+
|
|
17
|
+
---
|
|
18
|
+
|
|
19
|
+
## Part 1 — The method
|
|
20
|
+
|
|
21
|
+
The method — what a routine is, the register's fields, the status keys, how to run, add, retire and book a routine — is the shared [`docs/RoutineOperations.md`](https://github.com/Connextar/cx-house/blob/main/docs/RoutineOperations.md). Change it there, not here. In short:
|
|
22
|
+
|
|
23
|
+
- **At the start of a task, read Part 2's Next due column.** A 🟨 Due or 🟥 Overdue routine runs before new feature work, or the owner says why not.
|
|
24
|
+
- **Run it as its How says; never write to production** unless the How says so and the owner has said yes for this run. Reads against production need a go-ahead too, unless the row records a standing one.
|
|
25
|
+
- **Record it:** the full result in its Record, a line in the run log (Part 3), and the row's Last run, Next due and Status. Release if a status document changed ([ReleaseProcess.md](ReleaseProcess.md)).
|
|
26
|
+
- **New routines start ⚪ Proposed**, in the same change set as whatever needs them; retired ones go to 🧊 Paused, never deleted.
|
|
8
27
|
|
|
9
28
|
Status keys: ✅ On schedule · 🟨 Due · 🟥 Overdue · ⏰ Scheduled · 🤖 Automated · ⚪ Proposed · 🧊 Paused.
|
|
10
29
|
|
|
11
30
|
---
|
|
12
31
|
|
|
13
|
-
##
|
|
32
|
+
## Part 2 — App name's register
|
|
14
33
|
|
|
15
|
-
###
|
|
34
|
+
### 2.1 Manual routines
|
|
16
35
|
|
|
17
36
|
| ID | Routine | Why | When | How | Record | Last run | Next due | Status |
|
|
18
37
|
| ------ | ------- | --- | ---- | --- | ------ | -------- | -------- | ------ |
|
|
19
38
|
| OPS-01 | | | | | | | | |
|
|
20
39
|
|
|
21
|
-
###
|
|
40
|
+
### 2.2 Automated routines
|
|
22
41
|
|
|
23
42
|
The app runs these itself. The routine here is **watching** them: say where (a job-health page, a summary email, the host's cron dashboard), how often to look, and when to look sooner.
|
|
24
43
|
|
|
@@ -26,7 +45,7 @@ The app runs these itself. The routine here is **watching** them: say where (a j
|
|
|
26
45
|
| --- | --- | ------------ | ---- | ------ |
|
|
27
46
|
| | | | | |
|
|
28
47
|
|
|
29
|
-
###
|
|
48
|
+
### 2.3 Paused
|
|
30
49
|
|
|
31
50
|
| ID | Routine | Why paused | Since |
|
|
32
51
|
| --- | ------- | ---------- | ----- |
|
|
@@ -34,7 +53,7 @@ The app runs these itself. The routine here is **watching** them: say where (a j
|
|
|
34
53
|
|
|
35
54
|
---
|
|
36
55
|
|
|
37
|
-
##
|
|
56
|
+
## Part 3 — Run log
|
|
38
57
|
|
|
39
58
|
Newest first. One line a run: date · ID · who · result · follow-up.
|
|
40
59
|
|