release-please 14.9.0 → 14.10.0

package/CHANGELOG.md

@@ -4,6 +4,21 @@
 
 [1]: https://www.npmjs.com/package/release-please?activeTab=versions
 
+## [14.10.0](https://github.com/googleapis/release-please/compare/v14.9.0...v14.10.0) (2022-09-30)
+
+
+### Features
+
+* Add ability to set extra labels on components ([#1669](https://github.com/googleapis/release-please/issues/1669)) ([e05d43e](https://github.com/googleapis/release-please/commit/e05d43e0e9eb35ea7d9b47d7e0b13effc4c1422a)), closes [#1624](https://github.com/googleapis/release-please/issues/1624)
+* **cli:** Add debug command for loading a manifest config ([#1671](https://github.com/googleapis/release-please/issues/1671)) ([98078a3](https://github.com/googleapis/release-please/commit/98078a3d3fab0eeaf456fbcbe1827dc0185d0424))
+
+
+### Bug Fixes
+
+* **cli:** bootstrap command respects --dry-run argument ([67fcb19](https://github.com/googleapis/release-please/commit/67fcb19cf3a7334092c08b65ae7b2c83b16db5d6))
+* fix schema definition for label and release-label ([e05d43e](https://github.com/googleapis/release-please/commit/e05d43e0e9eb35ea7d9b47d7e0b13effc4c1422a))
+* Manifest config bootstrapper should include schema field ([#1670](https://github.com/googleapis/release-please/issues/1670)) ([67fcb19](https://github.com/googleapis/release-please/commit/67fcb19cf3a7334092c08b65ae7b2c83b16db5d6))
+
 ## [14.9.0](https://github.com/googleapis/release-please/compare/v14.8.0...v14.9.0) (2022-09-30)
 
 

package/build/src/bin/release-please.d.ts

@@ -1,7 +1,5 @@
 #!/usr/bin/env node
 import * as yargs from 'yargs';
-import { ChangelogSection } from '../changelog-notes';
-import { ReleaseType, VersioningStrategyType } from '../factory';
 interface ErrorObject {
     body?: object;
     status?: number;
@@ -23,47 +21,9 @@ interface ManifestArgs {
     configFile?: string;
     manifestFile?: string;
 }
-interface VersioningArgs {
-    bumpMinorPreMajor?: boolean;
-    bumpPatchForMinorPreMajor?: boolean;
-    releaseAs?: string;
-    lastPackageVersion?: string;
-    latestTagVersion?: string;
-    latestTagSha?: string;
-    latestTagName?: string;
+interface DebugConfigArgs extends GitHubArgs, ManifestArgs {
 }
-interface ManifestConfigArgs {
-    path?: string;
-    component?: string;
-    packageName?: string;
-    releaseType?: ReleaseType;
-}
-interface ReleaseArgs {
-    draft?: boolean;
-    prerelease?: boolean;
-    releaseLabel?: string;
-    snapshotLabel?: string;
-    label?: string;
-}
-interface PullRequestArgs {
-    draftPullRequest?: boolean;
-    label?: string;
-    skipLabeling?: boolean;
-    signoff?: string;
-}
-interface PullRequestStrategyArgs {
-    snapshot?: boolean;
-    changelogSections?: ChangelogSection[];
-    changelogPath?: string;
-    changelogHost?: string;
-    versioningStrategy?: VersioningStrategyType;
-    versionFile?: string;
-    extraFiles?: string[];
-}
-interface BootstrapArgs extends GitHubArgs, ManifestArgs, ManifestConfigArgs, VersioningArgs, PullRequestArgs, PullRequestStrategyArgs, ReleaseArgs {
-    initialVersion?: string;
-}
-export declare const parser: yargs.Argv<yargs.Omit<BootstrapArgs & {
+export declare const parser: yargs.Argv<yargs.Omit<DebugConfigArgs & {
     debug: boolean;
 }, "trace"> & {
     trace: boolean;

package/build/src/bin/release-please.js

@@ -472,7 +472,7 @@ const bootstrapCommand = {
             github.repository.defaultBranch;
         const bootstrapper = new bootstrapper_1.Bootstrapper(github, targetBranch, argv.manifestFile, argv.configFile, argv.initialVersion);
         const path = argv.path || manifest_1.ROOT_PROJECT_PATH;
-        const pullRequest = await bootstrapper.bootstrap(path, {
+        const releaserConfig = {
             releaseType: argv.releaseType,
             component: argv.component,
             packageName: argv.packageName,
@@ -488,8 +488,51 @@ const bootstrapCommand = {
             versioning: argv.versioningStrategy,
             extraFiles: argv.extraFiles,
             versionFile: argv.versionFile,
-        });
-        console.log(pullRequest);
+        };
+        if (argv.dryRun) {
+            const pullRequest = await await bootstrapper.buildPullRequest(path, releaserConfig);
+            console.log('Would open 1 pull request');
+            console.log('title:', pullRequest.title);
+            console.log('branch:', pullRequest.headBranchName);
+            console.log('body:', pullRequest.body);
+            console.log('updates:', pullRequest.updates.length);
+            const changes = await github.buildChangeSet(pullRequest.updates, targetBranch);
+            for (const update of pullRequest.updates) {
+                console.log(`  ${update.path}: `, 
+                // eslint-disable-next-line @typescript-eslint/no-explicit-any
+                update.updater.constructor);
+                if (argv.trace) {
+                    const change = changes.get(update.path);
+                    if (change) {
+                        const patch = (0, diff_1.createPatch)(update.path, change.originalContent || '', change.content || '');
+                        console.log(patch);
+                    }
+                    else {
+                        console.warn(`no change found for ${update.path}`);
+                    }
+                }
+            }
+        }
+        else {
+            const pullRequest = await bootstrapper.bootstrap(path, releaserConfig);
+            console.log(pullRequest);
+        }
+    },
+};
+const debugConfigCommand = {
+    command: 'debug-config',
+    describe: 'debug manifest config',
+    builder(yargs) {
+        return manifestConfigOptions(manifestOptions(gitHubOptions(yargs)));
+    },
+    async handler(argv) {
+        const github = await buildGitHub(argv);
+        const manifestOptions = extractManifestOptions(argv);
+        const targetBranch = argv.targetBranch ||
+            argv.defaultBranch ||
+            github.repository.defaultBranch;
+        const manifest = await manifest_1.Manifest.fromManifest(github, targetBranch, argv.configFile, argv.manifestFile, manifestOptions);
+        console.log(manifest);
     },
 };
 async function buildGitHub(argv) {
@@ -509,6 +552,7 @@ exports.parser = yargs
     .command(createManifestPullRequestCommand)
     .command(createManifestReleaseCommand)
     .command(bootstrapCommand)
+    .command(debugConfigCommand)
     .option('debug', {
     describe: 'print verbose errors (use only for local debugging).',
     default: false,

package/build/src/bootstrapper.d.ts

@@ -1,6 +1,10 @@
 import { GitHub } from './github';
 import { ReleaserConfig } from './manifest';
 import { PullRequest } from './pull-request';
+import { Update } from './update';
+interface BootstrapPullRequest extends PullRequest {
+    updates: Update[];
+}
 export declare class Bootstrapper {
     private github;
     private targetBranch;
@@ -9,4 +13,6 @@ export declare class Bootstrapper {
     private initialVersion;
     constructor(github: GitHub, targetBranch: string, manifestFile?: string, configFile?: string, initialVersionString?: string);
     bootstrap(path: string, config: ReleaserConfig): Promise<PullRequest>;
+    buildPullRequest(path: string, config: ReleaserConfig): Promise<BootstrapPullRequest>;
 }
+export {};

package/build/src/bootstrapper.js

@@ -27,17 +27,12 @@ class Bootstrapper {
         this.initialVersion = version_1.Version.parse(initialVersionString);
     }
     async bootstrap(path, config) {
+        const pullRequest = await this.buildPullRequest(path, config);
+        return await this.github.createPullRequest(pullRequest, this.targetBranch, pullRequest.title, pullRequest.updates, {});
+    }
+    async buildPullRequest(path, config) {
         const message = `chore: bootstrap releases for path: ${path}`;
         const branchName = path === manifest_1.ROOT_PROJECT_PATH ? 'default' : path;
-        const pullRequest = {
-            headBranchName: `release-please/bootstrap/${branchName}`,
-            baseBranchName: this.targetBranch,
-            number: -1,
-            title: message,
-            body: `Configuring release-please for path: ${path}`,
-            labels: [],
-            files: [],
-        };
         const version = this.initialVersion;
         const versionsMap = new Map();
         versionsMap.set(path, version);
@@ -53,7 +48,16 @@ class Bootstrapper {
                 updater: new release_please_config_1.ReleasePleaseConfig(path, config),
             },
         ];
-        return await this.github.createPullRequest(pullRequest, this.targetBranch, message, updates, {});
+        return {
+            title: message,
+            body: `Configuring release-please for path: ${path}`,
+            baseBranchName: this.targetBranch,
+            headBranchName: `release-please/bootstrap/${branchName}`,
+            updates,
+            number: -1,
+            labels: [],
+            files: [],
+        };
     }
 }
 exports.Bootstrapper = Bootstrapper;

package/build/src/manifest.d.ts

@@ -6,6 +6,7 @@ import { Logger } from './util/logger';
 import { ReleasePullRequest } from './release-pull-request';
 import { ReleaseType, VersioningStrategyType, ChangelogNotesType } from './factory';
 import { Release } from './release';
+import { ManifestPlugin } from './plugin';
 declare type ExtraJsonFile = {
     type: 'json';
     path: string;
@@ -53,6 +54,7 @@ export interface ReleaserConfig {
     separatePullRequests?: boolean;
     labels?: string[];
     releaseLabels?: string[];
+    extraLabels?: string[];
     initialVersion?: string;
     changelogSections?: ChangelogSection[];
     changelogPath?: string;
@@ -87,6 +89,7 @@ interface ReleaserConfigJson {
     'draft-pull-request'?: boolean;
     label?: string;
     'release-label'?: string;
+    'extra-label'?: string;
     'include-component-in-tag'?: boolean;
     'include-v-in-tag'?: boolean;
     'changelog-type'?: ChangelogNotesType;
@@ -194,7 +197,7 @@ export declare class Manifest {
     private sequentialCalls?;
     private releaseLabels;
     private snapshotLabels;
-    private plugins;
+    readonly plugins: ManifestPlugin[];
     private _strategiesByPath?;
     private _pathsByComponent?;
     private manifestPath;

package/build/src/manifest.js

@@ -73,7 +73,6 @@ class Manifest {
             (manifestOptions === null || manifestOptions === void 0 ? void 0 : manifestOptions.manifestPath) || exports.DEFAULT_RELEASE_PLEASE_MANIFEST;
         this.separatePullRequests =
             (_a = manifestOptions === null || manifestOptions === void 0 ? void 0 : manifestOptions.separatePullRequests) !== null && _a !== void 0 ? _a : Object.keys(repositoryConfig).length === 1;
-        this.plugins = (manifestOptions === null || manifestOptions === void 0 ? void 0 : manifestOptions.plugins) || [];
         this.fork = (manifestOptions === null || manifestOptions === void 0 ? void 0 : manifestOptions.fork) || false;
         this.signoffUser = manifestOptions === null || manifestOptions === void 0 ? void 0 : manifestOptions.signoff;
         this.releaseLabels =
@@ -94,6 +93,13 @@ class Manifest {
         this.commitSearchDepth =
             (manifestOptions === null || manifestOptions === void 0 ? void 0 : manifestOptions.commitSearchDepth) || DEFAULT_COMMIT_SEARCH_DEPTH;
         this.logger = (_b = manifestOptions === null || manifestOptions === void 0 ? void 0 : manifestOptions.logger) !== null && _b !== void 0 ? _b : logger_1.logger;
+        this.plugins = ((manifestOptions === null || manifestOptions === void 0 ? void 0 : manifestOptions.plugins) || []).map(pluginType => (0, factory_1.buildPlugin)({
+            type: pluginType,
+            github: this.github,
+            targetBranch: this.targetBranch,
+            repositoryConfig: this.repositoryConfig,
+            manifestPath: this.manifestPath,
+        }));
     }
     /**
      * Create a Manifest from config files in the repository.
@@ -311,16 +317,8 @@ class Manifest {
                 };
             }
         }
-        // Build plugins
-        const plugins = this.plugins.map(pluginType => (0, factory_1.buildPlugin)({
-            type: pluginType,
-            github: this.github,
-            targetBranch: this.targetBranch,
-            repositoryConfig: this.repositoryConfig,
-            manifestPath: this.manifestPath,
-        }));
         let strategies = strategiesByPath;
-        for (const plugin of plugins) {
+        for (const plugin of this.plugins) {
             strategies = await plugin.preconfigure(strategies, commitsPerPath, releasesByPath);
         }
         let newReleasePullRequests = [];
@@ -333,7 +331,7 @@ class Manifest {
             // The processCommits hook can be implemented by plugins to
             // post-process commits. This can be used to perform cleanup, e.g,, sentence
             // casing all commit messages:
-            for (const plugin of plugins) {
+            for (const plugin of this.plugins) {
                 pathCommits = plugin.processCommits(pathCommits);
             }
             this.logger.debug(`commits: ${pathCommits.length}`);
@@ -369,9 +367,9 @@ class Manifest {
         // Combine pull requests into 1 unless configured for separate
         // pull requests
         if (!this.separatePullRequests) {
-            plugins.push(new merge_1.Merge(this.github, this.targetBranch, this.repositoryConfig, this.groupPullRequestTitlePattern));
+            this.plugins.push(new merge_1.Merge(this.github, this.targetBranch, this.repositoryConfig, this.groupPullRequestTitlePattern));
         }
-        for (const plugin of plugins) {
+        for (const plugin of this.plugins) {
             this.logger.debug(`running plugin: ${plugin.constructor.name}`);
             newReleasePullRequests = await plugin.run(newReleasePullRequests);
         }
@@ -715,7 +713,7 @@ exports.Manifest = Manifest;
  * @returns {ReleaserConfig}
  */
 function extractReleaserConfig(config) {
-    var _a, _b;
+    var _a, _b, _c;
     return {
         releaseType: config['release-type'],
         bumpMinorPreMajor: config['bump-minor-pre-major'],
@@ -742,6 +740,7 @@ function extractReleaserConfig(config) {
         separatePullRequests: config['separate-pull-requests'],
         labels: (_a = config['label']) === null || _a === void 0 ? void 0 : _a.split(','),
         releaseLabels: (_b = config['release-label']) === null || _b === void 0 ? void 0 : _b.split(','),
+        extraLabels: (_c = config['extra-label']) === null || _c === void 0 ? void 0 : _c.split(','),
         skipSnapshot: config['skip-snapshot'],
         initialVersion: config['initial-version'],
     };
@@ -771,6 +770,7 @@ async function parseConfig(github, configFile, branch, onlyPath, releaseAs) {
     const configLabel = config['label'];
     const configReleaseLabel = config['release-label'];
     const configSnapshotLabel = config['snapshot-label'];
+    const configExtraLabel = config['extra-label'];
     const manifestOptions = {
         bootstrapSha: config['bootstrap-sha'],
         lastReleaseSha: config['last-release-sha'],
@@ -781,6 +781,7 @@ async function parseConfig(github, configFile, branch, onlyPath, releaseAs) {
         labels: configLabel === null || configLabel === void 0 ? void 0 : configLabel.split(','),
         releaseLabels: configReleaseLabel === null || configReleaseLabel === void 0 ? void 0 : configReleaseLabel.split(','),
         snapshotLabels: configSnapshotLabel === null || configSnapshotLabel === void 0 ? void 0 : configSnapshotLabel.split(','),
+        extraLabels: configExtraLabel === null || configExtraLabel === void 0 ? void 0 : configExtraLabel.split(','),
         releaseSearchDepth: config['release-search-depth'],
         commitSearchDepth: config['commit-search-depth'],
         sequentialCalls: config['sequential-calls'],
@@ -950,7 +951,7 @@ async function latestReleaseVersion(github, targetBranch, releaseFilter, config,
     return candidateTagVersion.sort((a, b) => b.compare(a))[0];
 }
 function mergeReleaserConfig(defaultConfig, pathConfig) {
-    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u, _v, _w, _x, _y, _z, _0;
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u, _v, _w, _x, _y, _z, _0, _1;
     return {
         releaseType: (_b = (_a = pathConfig.releaseType) !== null && _a !== void 0 ? _a : defaultConfig.releaseType) !== null && _b !== void 0 ? _b : 'node',
         bumpMinorPreMajor: (_c = pathConfig.bumpMinorPreMajor) !== null && _c !== void 0 ? _c : defaultConfig.bumpMinorPreMajor,
@@ -976,6 +977,7 @@ function mergeReleaserConfig(defaultConfig, pathConfig) {
         separatePullRequests: (_y = pathConfig.separatePullRequests) !== null && _y !== void 0 ? _y : defaultConfig.separatePullRequests,
         skipSnapshot: (_z = pathConfig.skipSnapshot) !== null && _z !== void 0 ? _z : defaultConfig.skipSnapshot,
         initialVersion: (_0 = pathConfig.initialVersion) !== null && _0 !== void 0 ? _0 : defaultConfig.initialVersion,
+        extraLabels: (_1 = pathConfig.extraLabels) !== null && _1 !== void 0 ? _1 : defaultConfig.extraLabels,
     };
 }
 /**

package/build/src/plugins/linked-versions.d.ts

@@ -16,9 +16,9 @@ interface LinkedVersionsPluginOptions {
  * Release notes are broken up using `<summary>`/`<details>` blocks.
  */
 export declare class LinkedVersions extends ManifestPlugin {
-    private groupName;
-    private components;
-    private merge;
+    readonly groupName: string;
+    readonly components: Set<string>;
+    readonly merge: boolean;
     constructor(github: GitHub, targetBranch: string, repositoryConfig: RepositoryConfig, groupName: string, components: string[], options?: LinkedVersionsPluginOptions);
     /**
      * Pre-configure strategies.

package/build/src/strategies/base.d.ts

@@ -48,6 +48,7 @@ export interface BaseStrategyOptions {
     skipSnapshot?: boolean;
     logger?: Logger;
     initialVersion?: string;
+    extraLabels?: string[];
 }
 /**
  * A strategy is responsible for determining which files are
@@ -73,6 +74,7 @@ export declare abstract class BaseStrategy implements Strategy {
     readonly pullRequestTitlePattern?: string;
     readonly pullRequestHeader?: string;
     readonly extraFiles: ExtraFile[];
+    readonly extraLabels: string[];
     readonly changelogNotes: ChangelogNotes;
     protected changelogSections?: ChangelogSection[];
     constructor(options: BaseStrategyOptions);

package/build/src/strategies/base.js

@@ -63,6 +63,7 @@ class BaseStrategy {
         this.pullRequestHeader = options.pullRequestHeader;
         this.extraFiles = options.extraFiles || [];
         this.initialVersion = options.initialVersion;
+        this.extraLabels = options.extraLabels || [];
     }
     /**
      * Return the component for this strategy. This may be a computed field.
@@ -172,7 +173,7 @@ class BaseStrategy {
             title: pullRequestTitle,
             body: pullRequestBody,
             updates: updatesWithExtras,
-            labels,
+            labels: [...labels, ...this.extraLabels],
             headRefName: branchName.toString(),
             version: newVersion,
             draft: draft !== null && draft !== void 0 ? draft : false,

package/build/src/strategies/java.js

@@ -99,7 +99,7 @@ class Java extends base_1.BaseStrategy {
             title: pullRequestTitle,
             body: pullRequestBody,
             updates: updatesWithExtras,
-            labels: labels,
+            labels: [...labels, ...this.extraLabels],
             headRefName: branchName.toString(),
             version: newVersion,
             draft: draft !== null && draft !== void 0 ? draft : false,

package/build/src/strategies/php-yoshi.js

@@ -147,7 +147,7 @@ class PHPYoshi extends base_1.BaseStrategy {
             title: pullRequestTitle,
             body: pullRequestBody,
             updates,
-            labels,
+            labels: [...labels, ...this.extraLabels],
             headRefName: branchName.toString(),
             version: newVersion,
             draft: draft !== null && draft !== void 0 ? draft : false,

package/build/src/updaters/release-please-manifest.js

@@ -16,12 +16,14 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ReleasePleaseManifest = void 0;
 const json_stringify_1 = require("../util/json-stringify");
 const default_1 = require("./default");
+const SCHEMA_URL = 'https://raw.githubusercontent.com/googleapis/release-please/main/schemas/config.json;';
 class ReleasePleaseManifest extends default_1.DefaultUpdater {
     updateContent(content) {
         const parsed = content ? JSON.parse(content) : {};
         for (const [path, version] of this.versionsMap) {
             parsed[path] = version.toString();
         }
+        parsed['$schema'] = SCHEMA_URL;
         if (content) {
             return (0, json_stringify_1.jsonStringify)(parsed, content);
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "release-please",
-  "version": "14.9.0",
+  "version": "14.10.0",
   "description": "generate release PRs based on the conventionalcommits.org spec",
   "main": "./build/src/index.js",
   "bin": "./build/src/bin/release-please.js",

package/schemas/config.json

@@ -66,12 +66,8 @@
           "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",
+        "extra-label": {
+          "description": "Comma-separated list of labels to add to a newly opened pull request",
           "type": "string"
         },
         "include-component-in-tag": {
@@ -345,6 +341,14 @@
         "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"
+        },
+        "label": {
+          "description": "Comma-separated list of labels to add to newly opened pull request. These are used to identify release pull requests.",
+          "type": "string"
+        },
+        "release-label": {
+          "description": "Comma-separated list of labels to add to a pull request that has been released/tagged",
+          "type": "string"
         }
       },
       "required": ["packages"]
@@ -373,6 +377,7 @@
     "draft-pull-request": true,
     "label": true,
     "release-label": true,
+    "extra-label": true,
     "include-component-in-tag": true,
     "include-v-in-tag": true,
     "changelog-type": true,