release-please 13.18.7 → 13.19.2

package/CHANGELOG.md

@@ -4,6 +4,27 @@
 
 [1]: https://www.npmjs.com/package/release-please?activeTab=versions
 
+## [13.19.2](https://github.com/googleapis/release-please/compare/v13.19.1...v13.19.2) (2022-07-06)
+
+
+### Bug Fixes
+
+* move schemas to their own directory and add to dist ([#1512](https://github.com/googleapis/release-please/issues/1512)) ([b7fb4ad](https://github.com/googleapis/release-please/commit/b7fb4ad6182a050a2c2a8376b4dd84d105b83438)), closes [#1511](https://github.com/googleapis/release-please/issues/1511)
+
+## [13.19.1](https://github.com/googleapis/release-please/compare/v13.19.0...v13.19.1) (2022-07-06)
+
+
+### Bug Fixes
+
+* fix file tree listing for extremely large repositories ([#1505](https://github.com/googleapis/release-please/issues/1505)) ([b6ea25e](https://github.com/googleapis/release-please/commit/b6ea25ef34720b16697f598d957604530908e195))
+
+## [13.19.0](https://github.com/googleapis/release-please/compare/v13.18.7...v13.19.0) (2022-06-30)
+
+
+### Features
+
+* add manifest schemas ([#1496](https://github.com/googleapis/release-please/issues/1496)) ([adf84ad](https://github.com/googleapis/release-please/commit/adf84ad3ebb8723ebc0e1232cd899c323c36cbfc))
+
 ## [13.18.7](https://github.com/googleapis/release-please/compare/v13.18.6...v13.18.7) (2022-06-30)
 
 

package/README.md

@@ -29,12 +29,12 @@ When the Release PR is merged, release-please takes the following steps:
 2. Tags the commit with the version number
 3. Creates a GitHub Release based on the tag
 
-You can tell where the Release PR is its lifecycle by the status label on the
+You can tell where the Release PR is in its lifecycle by the status label on the
 PR itself:
 
 - `autorelease: pending` is the initial state of the Release PR before it is merged
 - `autorelease: tagged` means that the Release PR has been merged and the release has been tagged in GitHub
-- `autorelease: snapshot` is special state for snapshot version bumps
+- `autorelease: snapshot` is a special state for snapshot version bumps
 - `autorelease: published` means that a GitHub release has been published based on the Release PR (_release-please does not automatically add this tag, but we recommend it as a convention for publication tooling_).
 
 ## How should I write my commits?
@@ -80,7 +80,7 @@ The above commit message will contain:
 
 ## How do I change the version number?
 
-When a commit to the main branch has `Release-As: x.x.x`(case insensitive) in the **commit body**, Release Please will open a new pull request for the specified version.
+When a commit to the main branch has `Release-As: x.x.x` (case insensitive) in the **commit body**, Release Please will open a new pull request for the specified version.
 
 **Empty commit example:**
 
@@ -94,7 +94,7 @@ Release-As: 2.0.0
 
 ## How can I fix release notes?
 
-If you have merged a pull request and you would like to amend the commit message
+If you have merged a pull request and would like to amend the commit message
 used to generate the release notes for that commit, you can edit the body of
 the merged pull requests and add a section like:
 
@@ -107,12 +107,12 @@ chore: a third message
 END_COMMIT_OVERRIDE
 ```
 
-The next time release please runs, it will use that override section as the
+The next time Release Please runs, it will use that override section as the
 commit message instead of the merged commit message.
 
 ## Release Please bot does not create a release PR. Why?
 
-Release Please creates a release pull request after it sees the default branch
+Release Please creates a release pull request after it notices the default branch
 contains "releasable units" since the last release.
 A releasable unit is a commit to the branch with one of the following
 prefixes: "feat" and "fix". (A "chore" commit is not a releasable unit.)
@@ -148,7 +148,7 @@ There are a variety of ways you can deploy release-please:
 
 ### GitHub Action (recommended)
 
-The easiest way to run release please is as a GitHub action. Please see [google-github-actions/release-please-action](https://github.com/google-github-actions/release-please-action) for installation and configuration instructions.
+The easiest way to run Release Please is as a GitHub action. Please see [google-github-actions/release-please-action](https://github.com/google-github-actions/release-please-action) for installation and configuration instructions.
 
 ### Running as CLI
 
@@ -206,12 +206,6 @@ This library follows [Semantic Versioning](http://semver.org/).
 
 Contributions welcome! See the [Contributing Guide](https://github.com/googleapis/release-please/blob/main/CONTRIBUTING.md).
 
-Please note that this `README.md`, the `samples/README.md`,
-and a variety of configuration files in this repository (including `.nycrc` and `tsconfig.json`)
-are generated from a central template. To edit one of these files, make an edit
-to its template in this
-[directory](https://github.com/googleapis/synthtool/tree/main/synthtool/gcp/templates/node_library).
-
 ## License
 
 Apache Version 2.0

package/build/src/index.d.ts

@@ -9,3 +9,5 @@ export { VersioningStrategyBuilder, VersioningStrategyFactoryOptions, Versioning
 export { BuildNotesOptions, ChangelogNotes, ChangelogSection, } from './changelog-notes';
 export { Logger, setLogger } from './util/logger';
 export { GitHub } from './github';
+export declare const configSchema: any;
+export declare const manifestSchema: any;

package/build/src/index.js

@@ -13,7 +13,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.GitHub = exports.setLogger = exports.registerVersioningStrategy = exports.getVersioningStrategyTypes = exports.registerPlugin = exports.getPluginTypes = exports.registerChangelogNotes = exports.getChangelogTypes = exports.registerReleaseType = exports.getReleaserTypes = exports.Manifest = exports.Errors = void 0;
+exports.manifestSchema = exports.configSchema = exports.GitHub = exports.setLogger = exports.registerVersioningStrategy = exports.getVersioningStrategyTypes = exports.registerPlugin = exports.getPluginTypes = exports.registerChangelogNotes = exports.getChangelogTypes = exports.registerReleaseType = exports.getReleaserTypes = exports.Manifest = exports.Errors = void 0;
 exports.Errors = require("./errors");
 var manifest_1 = require("./manifest");
 Object.defineProperty(exports, "Manifest", { enumerable: true, get: function () { return manifest_1.Manifest; } });
@@ -33,4 +33,6 @@ var logger_1 = require("./util/logger");
 Object.defineProperty(exports, "setLogger", { enumerable: true, get: function () { return logger_1.setLogger; } });
 var github_1 = require("./github");
 Object.defineProperty(exports, "GitHub", { enumerable: true, get: function () { return github_1.GitHub; } });
+exports.configSchema = require('../../schemas/config.json');
+exports.manifestSchema = require('../../schemas/manifest.json');
 //# sourceMappingURL=index.js.map

package/build/src/util/file-cache.js

@@ -173,12 +173,14 @@ class BranchFileCache {
      * @returns {TreeEntry[]} The tree entries
      */
     async fetchTree(sha) {
-        const { data: { tree }, } = await this.octokit.git.getTree({
+        const { data: { tree, truncated }, } = await this.octokit.git.getTree({
             owner: this.repository.owner,
             repo: this.repository.repo,
             tree_sha: sha,
-            recursive: 'false',
         });
+        if (truncated) {
+            logger_1.logger.warn(`file list for tree sha ${sha} is truncated`);
+        }
         return tree;
     }
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "release-please",
-  "version": "13.18.7",
+  "version": "13.19.2",
   "description": "generate release PRs based on the conventionalcommits.org spec",
   "main": "./build/src/index.js",
   "bin": "./build/src/bin/release-please.js",
@@ -18,7 +18,8 @@
   "files": [
     "build/src",
     "templates",
-    "!build/src/**/*.map"
+    "!build/src/**/*.map",
+    "schemas"
   ],
   "repository": "googleapis/release-please",
   "keywords": [
@@ -54,6 +55,7 @@
     "@types/sinon": "^10.0.0",
     "@types/xmldom": "^0.1.31",
     "@types/yargs": "^17.0.0",
+    "ajv": "^8.11.0",
     "c8": "^7.0.0",
     "chai": "^4.2.0",
     "cross-env": "^7.0.0",

package/schemas/config.json

@@ -0,0 +1,300 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "release-please manifest config schema",
+  "description": "Schema for defining manifest config file",
+  "type": "object",
+  "additionalProperties": false,
+  "definitions": {
+    "ReleaserConfigOptions": {
+      "type": "object",
+      "properties": {
+        "release-type": {
+          "description": "The strategy to use for this component.",
+          "type": "string"
+        },
+        "bump-minor-pre-major": {
+          "description": "Breaking changes only bump semver minor if version < 1.0.0",
+          "type": "boolean"
+        },
+        "bump-patch-for-minor-pre-major": {
+          "description": "Feature changes only bump semver patch if version < 1.0.0",
+          "type": "boolean"
+        },
+        "changelog-sections": {
+          "description": "Override the Changelog configuration sections",
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "type": {
+                "description": "Semantic commit type (e.g. `feat`, `chore`)",
+                "type": "string"
+              },
+              "section": {
+                "description": "Changelog section title",
+                "type": "string"
+              },
+              "hidden": {
+                "description": "Skip displaying this type of commit. Defaults to `false`.",
+                "type": "boolean"
+              }
+            },
+            "required": ["type", "section"]
+          }
+        },
+        "release-as": {
+          "description": "[DEPRECATED] Override the next version of this package. Consider using a `Release-As` commit instead.",
+          "type": "string"
+        },
+        "skip-github-release": {
+          "description": "Skip tagging GitHub releases for this package. Defaults to `false`.",
+          "type": "boolean"
+        },
+        "draft": {
+          "description": "Create the GitHub release in draft mode. Defaults to `false`.",
+          "type": "boolean"
+        },
+        "prerelease": {
+          "description": "Create the GitHub release as prerelease. Defaults to `false`.",
+          "type": "boolean"
+        },
+        "draft-pull-request": {
+          "description": "Open the release pull request in draft mode. Defaults to `false`.",
+          "type": "boolean"
+        },
+        "label": {
+          "description": "Comma-separated list of labels to add to newly opened pull request",
+          "type": "string"
+        },
+        "release-label": {
+          "description": "Comma-separated list of labels to add to a pull request that has been released/tagged",
+          "type": "string"
+        },
+        "include-component-in-tag": {
+          "description": "When tagging a release, include the component name as part of the tag. Defaults to `true`.",
+          "type": "boolean"
+        },
+        "include-v-in-tag": {
+          "description": "When tagging a release, include `v` in the tag. Defaults to `false`.",
+          "type": "boolean"
+        },
+        "changelog-type": {
+          "description": "The type of changelog to use. Defaults to `default`.",
+          "type": "string",
+          "enum": ["default", "github"]
+        },
+        "changelog-host": {
+          "description": "Generate changelog links to this GitHub host. Useful for running against GitHub Enterprise.",
+          "type": "string"
+        },
+        "pull-request-title-pattern": {
+          "description": "Customize the release pull request title.",
+          "type": "string"
+        },
+        "separate-pull-requests": {
+          "description": "Open a separate release pull request for each component. Defaults to `false`.",
+          "type": "boolean"
+        },
+        "tag-separator": {
+          "description": "Customize the separator between the component and version in the GitHub tag.",
+          "type": "string"
+        },
+        "extra-files": {
+          "description": "Specify extra generic files to replace versions.",
+          "type": "array",
+          "items": {
+            "anyOf": [
+              {
+                "description": "The path to the file. The `Generic` updater uses annotations to replace versions.",
+                "type": "string"
+              },
+              {
+                "description": "An extra JSON on YAML file with a targeted update via jsonpath.",
+                "type": "object",
+                "properties": {
+                  "type": {
+                    "description": "The file format type.",
+                    "enum": ["json", "yaml"]
+                  },
+                  "path": {
+                    "description": "The path to the file.",
+                    "type": "string"
+                  },
+                  "jsonpath": {
+                    "description": "The jsonpath to the version entry in the file.",
+                    "type": "string"
+                  }
+                },
+                "required": ["type", "path", "jsonpath"]
+              },
+              {
+                "description": "An extra XML file with a targeted update via xpath.",
+                "type": "object",
+                "properties": {
+                  "type": {
+                    "description": "The file format type.",
+                    "enum": ["xml"]
+                  },
+                  "path": {
+                    "description": "The path to the file.",
+                    "type": "string"
+                  },
+                  "xpath": {
+                    "description": "The xpath to the version entry in the file.",
+                    "type": "string"
+                  }
+                },
+                "required": ["type", "path", "xpath"]
+              },
+              {
+                "description": "An extra pom.xml file.",
+                "type": "object",
+                "properties": {
+                  "type": {
+                    "description": "The file format type.",
+                    "enum": ["pom"]
+                  },
+                  "path": {
+                    "description": "The path to the file.",
+                    "type": "string"
+                  }
+                },
+                "required": ["type", "path"]
+              }
+            ]
+          }
+        },
+        "version-file": {
+          "description": "Path to the specialize version file. Used by `ruby` and `simple` strategies.",
+          "type": "string"
+        },
+        "snapshot-label": {
+          "description": "Label to add to snapshot pull request. Used by `java` strategies.",
+          "type": "string"
+        }
+      }
+    }
+  },
+  "allOf": [
+    {
+      "$ref": "#/definitions/ReleaserConfigOptions"
+    },
+    {
+      "properties": {
+        "packages": {
+          "description": "Per-path component configuration.",
+          "type": "object",
+          "additionalProperties": {
+            "$ref": "#/definitions/ReleaserConfigOptions"
+          }
+        },
+        "bootstrap-sha": {
+          "description": "For the initial release of a library, only consider as far back as this commit SHA. This is an uncommon use case and should generally be avoided.",
+          "type": "string"
+        },
+        "last-release-sha": {
+          "description": "For any release, only consider as far back as this commit SHA. This is an uncommon use case and should generally be avoided.",
+          "type": "string"
+        },
+        "always-link-local": {
+          "description": "When using the `node-workspace` plugin, force all local dependencies to be linked.",
+          "type": "boolean"
+        },
+        "plugins": {
+          "description": "Plugins to apply to pull requests. Plugins can be added to perform extra release processing that cannot be achieved by an individual release strategy.",
+          "type": "array",
+          "items": {
+            "anyOf": [
+              {
+                "description": "The plugin name for plugins that do not require other options.",
+                "type": "string"
+              },
+              {
+                "description": "Configuration for the `linked-versions` plugin.",
+                "type": "object",
+                "properties": {
+                  "type": {
+                    "description": "The name of the plugin.",
+                    "type": "string",
+                    "enum": ["linked-versions"]
+                  },
+                  "groupName": {
+                    "description": "The name of the group of components.",
+                    "type": "string"
+                  },
+                  "components": {
+                    "description": "List of component names that are part of this group.",
+                    "type": "array",
+                    "items": {
+                      "type": "string"
+                    }
+                  }
+                },
+                "required": ["type", "groupName", "components"]
+              },
+              {
+                "description": "Other plugins",
+                "type": "object",
+                "properties": {
+                  "type": {
+                    "description": "The name of the plugin.",
+                    "type": "string"
+                  }
+                }
+              }
+            ]
+          }
+        },
+        "group-pull-request-title-pattern": {
+          "description": "When grouping multiple release pull requests use this pattern for the title.",
+          "type": "string"
+        },
+        "release-search-depth": {
+          "description": "When considering previously releases, only look this deep.",
+          "type": "number"
+        },
+        "commit-search-depth": {
+          "description": "When considering commit history, only look this many commits deep.",
+          "type": "number"
+        },
+        "sequential-calls": {
+          "description": "Whether to open pull requests/releases sequentially rather than concurrently. If you have many components, you may want to set this to avoid secondary rate limits.",
+          "type": "boolean"
+        }
+      },
+      "required": ["packages"]
+    }
+  ],
+  "properties": {
+    "packages": true,
+    "bootstrap-sha": true,
+    "last-release-sha": true,
+    "always-link-local": true,
+    "plugins": true,
+    "group-pull-request-title-pattern": true,
+    "release-search-depth": true,
+    "commit-search-depth": true,
+    "sequential-calls": true,
+    "release-type": true,
+    "bump-minor-pre-major": true,
+    "bump-patch-for-minor-pre-major": true,
+    "changelog-sections": true,
+    "release-as": true,
+    "skip-github-release": true,
+    "draft": true,
+    "prerelease": true,
+    "draft-pull-request": true,
+    "label": true,
+    "release-label": true,
+    "include-component-in-tag": true,
+    "include-v-in-tag": true,
+    "changelog-type": true,
+    "changelog-host": true,
+    "pull-request-title-pattern": true,
+    "separate-pull-requests": true,
+    "tag-separator": true,
+    "extra-files": true,
+    "version-file": true,
+    "snapshot-label": true
+  }
+}

package/schemas/manifest.json

@@ -0,0 +1,9 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "release-please manifest config versions",
+  "description": "Schema for defining manifest versions file",
+  "type": "object",
+  "additionalProperties": {
+    "type": "string"
+  }
+}