@noldova/tools.pipelines.github 0.0.13 → 0.0.14

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 CHANGED
@@ -16,7 +16,7 @@ npm install @noldova/tools.pipelines.github
16
16
  A job installs the package at an exact version, without install scripts, and calls `pipelines` with a step's name and values in the checkout:
17
17
 
18
18
  ```yaml
19
- - run: npm install --global --ignore-scripts @noldova/tools.pipelines.github@0.0.13
19
+ - run: npm install --global --ignore-scripts @noldova/tools.pipelines.github@0.0.14
20
20
  - run: pipelines source "$VERSION" "$COMMIT"
21
21
  - id: nightly
22
22
  run: |
@@ -48,7 +48,7 @@ The reproducible, dependents and pins steps make their temporary folders in `RUN
48
48
  - A step that succeeds writes its message to standard output and exits with code `0`; an empty message, such as the nightly step's when nothing changed, writes nothing.
49
49
  - A step that fails writes its message as one error annotation, which the run's summary shows, and exits with code `1`; so does a first value that names no step, with the usage line of every step.
50
50
  Outside GitHub Actions, where `GITHUB_ACTIONS` isn't `true`, such as when a person builds on their machine, it writes the message as it is.
51
- - The build and test steps write their progress, such as each package they build, to standard output as they go.
51
+ - The build and test steps write their progress to standard output as they go, one line for each package they build or whose tests they compile, such as `Building @noldova/example... Done.`, which ends with ` Failed.` before the step's error.
52
52
  - The annotation goes to standard error, which GitHub Actions reads workflow commands from as it does standard output, so a step whose output the workflow keeps, such as the nightly version above, still shows it.
53
53
  - A fault, such as git failing to start, ends the run with its stack trace and exit code `1`.
54
54
 
package/api/index.d.ts CHANGED
@@ -48,6 +48,22 @@ export declare class GitHubStepOutput implements IStepOutput {
48
48
  */
49
49
  public writeProgress(message: string): void;
50
50
 
51
+ /**
52
+ * Writes the start of a progress line to standard output, without a line
53
+ * feed; the next `writeProgress` ends the line.
54
+ *
55
+ * @param message The line's start.
56
+ * @example
57
+ * ```ts
58
+ * import { GitHubStepOutput } from "@noldova/tools.pipelines.github";
59
+ *
60
+ * const output = new GitHubStepOutput(process.stdout, process.stderr);
61
+ * output.writeProgressStart("Building @noldova/tools.pipelines...");
62
+ * output.writeProgress(" Done."); // the two write "Building @noldova/tools.pipelines... Done.\n"
63
+ * ```
64
+ */
65
+ public writeProgressStart(message: string): void;
66
+
51
67
  /**
52
68
  * Writes the message of a step that succeeded, and a line feed, to standard
53
69
  * output; an empty message writes nothing.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@noldova/tools.pipelines.github",
3
- "version": "0.0.13",
3
+ "version": "0.0.14",
4
4
  "type": "module",
5
5
  "main": "api/index.js",
6
6
  "types": "api/index.d.ts",
@@ -23,7 +23,7 @@
23
23
  },
24
24
  "dependencies": {
25
25
  "@noldova/context.json": "0.0.3",
26
- "@noldova/tools.pipelines": "0.0.13"
26
+ "@noldova/tools.pipelines": "0.0.14"
27
27
  },
28
- "gitHead": "2ce943cb9e2d2f320cb49010536f11fa8501fe96"
28
+ "gitHead": "3a11e80259a2e9344f4ba7f5996081917d445091"
29
29
  }
@@ -18,6 +18,9 @@ export class GitHubStepOutput {
18
18
  writeProgress(message) {
19
19
  this.standardOutput.write(`${message}${Resources.lineSeparator}`);
20
20
  }
21
+ writeProgressStart(message) {
22
+ this.standardOutput.write(message);
23
+ }
21
24
  writeSuccess(message) {
22
25
  if (message.length > 0)
23
26
  this.standardOutput.write(`${message}${Resources.lineSeparator}`);
@@ -1 +1 @@
1
- {"version":3,"file":"github-step-output.js","sourceRoot":"","sources":["../../../../src/noldova.tools.pipelines.github/src/services/github-step-output.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAIH,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAE5C,MAAM,OAAO,gBAAgB;IACV,cAAc,CAAwB;IACtC,aAAa,CAAwB;IACrC,SAAS,CAAU;IAEpC,YAAmB,cAAqC,EAAE,aAAoC,EAAE,SAAS,GAAY,IAAI;QACvH,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;QACrC,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;QACnC,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC7B,CAAC;IAEM,aAAa,CAAC,OAAe;QAClC,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,GAAG,OAAO,GAAG,SAAS,CAAC,aAAa,EAAE,CAAC,CAAC;IACpE,CAAC;IAEM,YAAY,CAAC,OAAe;QACjC,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC;YACpB,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,GAAG,OAAO,GAAG,SAAS,CAAC,aAAa,EAAE,CAAC,CAAC;IACtE,CAAC;IAEM,YAAY,CAAC,OAAe;QACjC,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC;YACpB,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,qBAAqB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG,OAAO,GAAG,SAAS,CAAC,aAAa,EAAE,CAAC,CAAC;IACjI,CAAC;CACF"}
1
+ {"version":3,"file":"github-step-output.js","sourceRoot":"","sources":["../../../../src/noldova.tools.pipelines.github/src/services/github-step-output.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAIH,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAE5C,MAAM,OAAO,gBAAgB;IACV,cAAc,CAAwB;IACtC,aAAa,CAAwB;IACrC,SAAS,CAAU;IAEpC,YAAmB,cAAqC,EAAE,aAAoC,EAAE,SAAS,GAAY,IAAI;QACvH,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;QACrC,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;QACnC,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC7B,CAAC;IAEM,aAAa,CAAC,OAAe;QAClC,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,GAAG,OAAO,GAAG,SAAS,CAAC,aAAa,EAAE,CAAC,CAAC;IACpE,CAAC;IAEM,kBAAkB,CAAC,OAAe;QACvC,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IACrC,CAAC;IAEM,YAAY,CAAC,OAAe;QACjC,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC;YACpB,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,GAAG,OAAO,GAAG,SAAS,CAAC,aAAa,EAAE,CAAC,CAAC;IACtE,CAAC;IAEM,YAAY,CAAC,OAAe;QACjC,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC;YACpB,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,qBAAqB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG,OAAO,GAAG,SAAS,CAAC,aAAa,EAAE,CAAC,CAAC;IACjI,CAAC;CACF"}