werkmeister-core 0.93.7 → 0.93.8

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/CHANGELOG.md CHANGED
@@ -1,5 +1,11 @@
1
1
  # sandbox-core
2
2
 
3
+ ## 0.93.8
4
+
5
+ ### Patch Changes
6
+
7
+ - a04b961: PR file: the generated `pr-rules.md` template quotes `reason`, `skip_*` and `hold` and says to quote free-text values, and the "PR file needs YAML frontmatter" error now says to quote values that contain a colon (SW-731).
8
+
3
9
  ## 0.93.7
4
10
 
5
11
  ### Patch Changes
@@ -170,7 +170,7 @@ function parsePrFile(p) {
170
170
  fm = m ? YAML.parse(m[1]) : null;
171
171
  }
172
172
  catch (e) {
173
- yamlError = ` YAML error: ${e.message}`;
173
+ yamlError = ` YAML error: ${e.message}\nQuote values that contain a colon, e.g. skip_release: "no changeset: docs only".`;
174
174
  }
175
175
  if (!m || typeof fm !== "object" || fm === null || Array.isArray(fm)) {
176
176
  throw new WorkspaceError(`${p}: PR file needs YAML frontmatter between --- lines (see pr-rules.md).${yamlError}`);
package/dist/pr_rules.js CHANGED
@@ -48,17 +48,19 @@ status: draft # draft | approved | open | merged | shipped | closed |
48
48
  url: # written by werkmeister pr open
49
49
  merge_sha: # written by werkmeister pr status
50
50
  release: # release tag that shipped it, written by werkmeister pr status; \`none\` for a merged skip_release PR with no changeset (changesets repos), else set it yourself for a change that ships nothing
51
- reason: # required for closed / abandoned
51
+ reason: "" # required for closed / abandoned
52
52
  skip_tests: {} # <service>: <reason> — for a service with no test command or no running container (a service that has no tests says \`test: none: <reason>\` in its registry entry instead); tests: <reason> when no service maps to the changed files
53
- skip_release: # <reason> — skips the gate's release check; a ship: tag repo still waits for its release tag unless release: none, or the merged PR has no changeset
54
- skip_exercise: # <reason> — skips the gate's exercise check, e.g. a doc deliverable with nothing to run
55
- skip_review: # <reason> — skips the gate's review check, e.g. a doc deliverable with no code to review
56
- hold: # <reason> — pr open opens the PR as a draft, body starting "Don't merge until: <reason>"; when the step is done, gh pr ready <url> and empty this (rule 6)
53
+ skip_release: "" # <reason> — skips the gate's release check; a ship: tag repo still waits for its release tag unless release: none, or the merged PR has no changeset
54
+ skip_exercise: "" # <reason> — skips the gate's exercise check, e.g. a doc deliverable with nothing to run
55
+ skip_review: "" # <reason> — skips the gate's review check, e.g. a doc deliverable with no code to review
56
+ hold: "" # <reason> — pr open opens the PR as a draft, body starting "Don't merge until: <reason>"; when the step is done, gh pr ready <url> and empty this (rule 6)
57
57
  ---
58
58
  # <PR title>
59
59
  <PR body: summary, test and exercise results, acceptance table, Fixes <issue>>
60
60
  \`\`\`
61
61
 
62
+ **Quote free-text values.** \`reason\`, \`skip_*\` (each \`skip_tests\` entry too) and \`hold\` take a double-quoted string, e.g. \`skip_release: "no changeset: docs only"\`. An unquoted value that contains \`: \` is invalid YAML and \`werkmeister pr open\` fails on it.
63
+
62
64
  **Acceptance table.** One row per criterion. The result cell holds exactly \`PASS\` or \`FAIL\` and nothing else; evidence goes in its own column. A criterion only the reviewer can check (it needs a real PR, the desktop app or the real machine) reads \`MANUAL\`, with why in the evidence: the gate passes it and lists it, and never \`PASS\` for a check nobody ran. Only this table takes \`MANUAL\`; exercise and review rows are PASS or FAIL. \`| criterion | PASS: repro.md §1 |\` fails the gate.
63
65
 
64
66
  \`\`\`markdown
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "werkmeister-core",
3
- "version": "0.93.7",
3
+ "version": "0.93.8",
4
4
  "license": "Apache-2.0",
5
5
  "type": "module",
6
6
  "description": "werkmeister's shared library. Its public API is werkmeister-core/sdk; every other entry point is internal.",