@monosmith/plugin-sdk 2.0.0-beta.5 → 2.0.0-beta.6

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
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@monosmith/plugin-sdk",
3
- "version": "2.0.0-beta.5",
3
+ "version": "2.0.0-beta.6",
4
4
  "description": "The TypeScript SDK for writing smith plugins: the protocol's types, the serve loop, a test host, the conformance checks, templating and key-order-keeping JSON editing. No runtime dependencies.",
5
5
  "license": "MIT",
6
6
  "type": "module",
@@ -2064,6 +2064,13 @@ export const protocolSchema = {
2064
2064
  "registry": {
2065
2065
  "type": "string"
2066
2066
  },
2067
+ "notes": {
2068
+ "type": "array",
2069
+ "items": {
2070
+ "type": "string"
2071
+ },
2072
+ "description": "Notes are things the person must know about a publish that succeeded, such as a dist-tag that was not moved; the host prints them and the report keeps them."
2073
+ },
2067
2074
  "assets": {
2068
2075
  "type": "array",
2069
2076
  "items": {
@@ -1100,6 +1100,11 @@ export interface PublishResult {
1100
1100
  published: boolean;
1101
1101
  skipped?: string;
1102
1102
  registry?: string;
1103
+ /**
1104
+ * Notes are things the person must know about a publish that succeeded, such as a dist-tag that
1105
+ * was not moved; the host prints them and the report keeps them.
1106
+ */
1107
+ notes?: string[];
1103
1108
  /**
1104
1109
  * Assets are the workspace-relative files built for the release, in upload order; in a dry run,
1105
1110
  * the files that would be built.