release-please 13.19.7 → 13.20.0

package/CHANGELOG.md

@@ -4,6 +4,28 @@
 
 [1]: https://www.npmjs.com/package/release-please?activeTab=versions
 
+## [13.20.0](https://github.com/googleapis/release-please/compare/v13.19.9...v13.20.0) (2022-08-08)
+
+
+### Features
+
+* allow plugins to skip merging in-scope pull requests ([#1550](https://github.com/googleapis/release-please/issues/1550)) ([354b1dc](https://github.com/googleapis/release-please/commit/354b1dc89c468e44b59507b4bb2f15d6723110ed))
+* allow skipping snapshots for java strategies ([#1555](https://github.com/googleapis/release-please/issues/1555)) ([3430693](https://github.com/googleapis/release-please/commit/34306932e5fe21c89020b184a527c220d10c8390))
+
+## [13.19.9](https://github.com/googleapis/release-please/compare/v13.19.8...v13.19.9) (2022-08-08)
+
+
+### Bug Fixes
+
+* php root-composer-update-packages version replace ([#1553](https://github.com/googleapis/release-please/issues/1553)) ([41127e6](https://github.com/googleapis/release-please/commit/41127e688597a0af6502957d85ba8cd6214e9008))
+
+## [13.19.8](https://github.com/googleapis/release-please/compare/v13.19.7...v13.19.8) (2022-08-03)
+
+
+### Bug Fixes
+
+* convert ReleaserConfig JSON keys when bootstrapping ([#1535](https://github.com/googleapis/release-please/issues/1535)) ([64c267e](https://github.com/googleapis/release-please/commit/64c267e1c986029b6c483b924950135c138c510f)), closes [#1522](https://github.com/googleapis/release-please/issues/1522)
+
 ## [13.19.7](https://github.com/googleapis/release-please/compare/v13.19.6...v13.19.7) (2022-08-03)
 
 

package/README.md

@@ -206,6 +206,8 @@ This library follows [Semantic Versioning](http://semver.org/).
 
 Contributions welcome! See the [Contributing Guide](https://github.com/googleapis/release-please/blob/main/CONTRIBUTING.md).
 
+For more information on the design of the library, see [design](https://github.com/googleapis/release-please/blob/main/docs/design.md).
+
 ## License
 
 Apache Version 2.0

package/build/src/factories/plugin-factory.js

@@ -29,7 +29,10 @@ function buildPlugin(options) {
     if (typeof options.type === 'object') {
         const builder = pluginFactories[options.type.type];
         if (builder) {
-            return builder(options);
+            return builder({
+                ...options.type,
+                ...options,
+            });
         }
         throw new errors_1.ConfigurationError(`Unknown plugin type: ${options.type.type}`, 'core', `${options.github.repository.owner}/${options.github.repository.repo}`);
     }

package/build/src/manifest.d.ts

@@ -45,6 +45,8 @@ export interface ReleaserConfig {
     pullRequestTitlePattern?: string;
     tagSeparator?: string;
     separatePullRequests?: boolean;
+    labels?: string[];
+    releaseLabels?: string[];
     changelogSections?: ChangelogSection[];
     changelogPath?: string;
     changelogType?: ChangelogNotesType;
@@ -52,6 +54,7 @@ export interface ReleaserConfig {
     versionFile?: string;
     extraFiles?: ExtraFile[];
     snapshotLabels?: string[];
+    skipSnapshot?: boolean;
 }
 export interface CandidateReleasePullRequest {
     path: string;
@@ -83,9 +86,10 @@ interface ReleaserConfigJson {
     'pull-request-title-pattern'?: string;
     'separate-pull-requests'?: boolean;
     'tag-separator'?: string;
-    'extra-files'?: string[];
+    'extra-files'?: ExtraFile[];
     'version-file'?: string;
     'snapshot-label'?: string;
+    'skip-snapshot'?: boolean;
 }
 export interface ManifestOptions {
     bootstrapSha?: string;
@@ -108,7 +112,7 @@ export interface ManifestOptions {
     releaseSearchDepth?: number;
     commitSearchDepth?: number;
 }
-interface ReleaserPackageConfig extends ReleaserConfigJson {
+export interface ReleaserPackageConfig extends ReleaserConfigJson {
     'package-name'?: string;
     component?: string;
     'changelog-path'?: string;
@@ -121,8 +125,12 @@ export interface LinkedVersionPluginConfig extends ConfigurablePluginType {
     type: 'linked-versions';
     groupName: string;
     components: string[];
+    merge?: boolean;
+}
+export interface WorkspacePluginConfig extends ConfigurablePluginType {
+    merge?: boolean;
 }
-export declare type PluginType = DirectPluginType | ConfigurablePluginType | LinkedVersionPluginConfig;
+export declare type PluginType = DirectPluginType | ConfigurablePluginType | LinkedVersionPluginConfig | WorkspacePluginConfig;
 /**
  * This is the schema of the manifest config json
  */

package/build/src/manifest.js

@@ -365,6 +365,7 @@ class Manifest {
             plugins.push(new merge_1.Merge(this.github, this.targetBranch, this.repositoryConfig, this.groupPullRequestTitlePattern));
         }
         for (const plugin of plugins) {
+            logger_1.logger.debug(`running plugin: ${plugin.constructor.name}`);
             newReleasePullRequests = await plugin.run(newReleasePullRequests);
         }
         return newReleasePullRequests.map(pullRequestWithConfig => pullRequestWithConfig.pullRequest);
@@ -707,6 +708,7 @@ exports.Manifest = Manifest;
  * @returns {ReleaserConfig}
  */
 function extractReleaserConfig(config) {
+    var _a, _b;
     return {
         releaseType: config['release-type'],
         bumpMinorPreMajor: config['bump-minor-pre-major'],
@@ -729,6 +731,9 @@ function extractReleaserConfig(config) {
         pullRequestTitlePattern: config['pull-request-title-pattern'],
         tagSeparator: config['tag-separator'],
         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(','),
+        skipSnapshot: config['skip-snapshot'],
     };
 }
 /**
@@ -763,9 +768,9 @@ async function parseConfig(github, configFile, branch, onlyPath, releaseAs) {
         separatePullRequests: config['separate-pull-requests'],
         groupPullRequestTitlePattern: config['group-pull-request-title-pattern'],
         plugins: config['plugins'],
-        labels: configLabel === undefined ? undefined : [configLabel],
-        releaseLabels: configReleaseLabel === undefined ? undefined : [configReleaseLabel],
-        snapshotLabels: configSnapshotLabel === undefined ? undefined : [configSnapshotLabel],
+        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(','),
         releaseSearchDepth: config['release-search-depth'],
         commitSearchDepth: config['commit-search-depth'],
         sequentialCalls: config['sequential-calls'],
@@ -933,7 +938,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;
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u, _v, _w, _x;
     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,
@@ -955,6 +960,7 @@ function mergeReleaserConfig(defaultConfig, pathConfig) {
         tagSeparator: (_u = pathConfig.tagSeparator) !== null && _u !== void 0 ? _u : defaultConfig.tagSeparator,
         pullRequestTitlePattern: (_v = pathConfig.pullRequestTitlePattern) !== null && _v !== void 0 ? _v : defaultConfig.pullRequestTitlePattern,
         separatePullRequests: (_w = pathConfig.separatePullRequests) !== null && _w !== void 0 ? _w : defaultConfig.separatePullRequests,
+        skipSnapshot: (_x = pathConfig.skipSnapshot) !== null && _x !== void 0 ? _x : defaultConfig.skipSnapshot,
     };
 }
 /**

package/build/src/plugins/cargo-workspace.js

@@ -178,10 +178,16 @@ class CargoWorkspace extends workspace_1.WorkspacePlugin {
         };
     }
     postProcessCandidates(candidates, updatedVersions) {
-        const rootCandidate = candidates.find(c => c.path === manifest_1.ROOT_PROJECT_PATH);
+        let rootCandidate = candidates.find(c => c.path === manifest_1.ROOT_PROJECT_PATH);
         if (!rootCandidate) {
-            throw Error('Unable to find root candidate pull request');
+            logger_1.logger.warn('Unable to find root candidate pull request');
+            rootCandidate = candidates.find(c => c.config.releaseType === 'rust');
         }
+        if (!rootCandidate) {
+            logger_1.logger.warn('Unable to find a rust candidate pull request');
+            return candidates;
+        }
+        // Update the root Cargo.lock if it exists
         rootCandidate.pullRequest.updates.push({
             path: 'Cargo.lock',
             createIfMissing: false,

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

@@ -4,6 +4,9 @@ import { GitHub } from '../github';
 import { Strategy } from '../strategy';
 import { Commit } from '../commit';
 import { Release } from '../release';
+interface LinkedVersionsPluginOptions {
+    merge?: boolean;
+}
 /**
  * This plugin reconfigures strategies by linking multiple components
  * together.
@@ -13,7 +16,8 @@ import { Release } from '../release';
 export declare class LinkedVersions extends ManifestPlugin {
     private groupName;
     private components;
-    constructor(github: GitHub, targetBranch: string, repositoryConfig: RepositoryConfig, groupName: string, components: string[]);
+    private merge;
+    constructor(github: GitHub, targetBranch: string, repositoryConfig: RepositoryConfig, groupName: string, components: string[], options?: LinkedVersionsPluginOptions);
     /**
      * Pre-configure strategies.
      * @param {Record<string, Strategy>} strategiesByPath Strategies indexed by path
@@ -27,3 +31,4 @@ export declare class LinkedVersions extends ManifestPlugin {
      */
     run(candidates: CandidateReleasePullRequest[]): Promise<CandidateReleasePullRequest[]>;
 }
+export {};

package/build/src/plugins/linked-versions.js

@@ -25,10 +25,12 @@ const merge_1 = require("./merge");
  * Release notes are broken up using `<summary>`/`<details>` blocks.
  */
 class LinkedVersions extends plugin_1.ManifestPlugin {
-    constructor(github, targetBranch, repositoryConfig, groupName, components) {
+    constructor(github, targetBranch, repositoryConfig, groupName, components, options = {}) {
+        var _a;
         super(github, targetBranch, repositoryConfig);
         this.groupName = groupName;
         this.components = new Set(components);
+        this.merge = (_a = options.merge) !== null && _a !== void 0 ? _a : true;
     }
     /**
      * Pre-configure strategies.
@@ -99,6 +101,9 @@ class LinkedVersions extends plugin_1.ManifestPlugin {
      * @returns {CandidateReleasePullRequest[]} Updated pull requests
      */
     async run(candidates) {
+        if (!this.merge) {
+            return candidates;
+        }
         const [inScopeCandidates, outOfScopeCandidates] = candidates.reduce((collection, candidate) => {
             if (!candidate.pullRequest.version) {
                 logger_1.logger.warn('pull request missing version', candidate);

package/build/src/plugins/workspace.d.ts

@@ -10,6 +10,7 @@ export interface DependencyNode<T> {
 export interface WorkspacePluginOptions {
     manifestPath?: string;
     updateAllPackages?: boolean;
+    merge?: boolean;
 }
 export interface AllPackages<T> {
     allPackages: T[];
@@ -29,6 +30,7 @@ export interface AllPackages<T> {
 export declare abstract class WorkspacePlugin<T> extends ManifestPlugin {
     private updateAllPackages;
     private manifestPath;
+    private merge;
     constructor(github: GitHub, targetBranch: string, repositoryConfig: RepositoryConfig, options?: WorkspacePluginOptions);
     run(candidates: CandidateReleasePullRequest[]): Promise<CandidateReleasePullRequest[]>;
     /**

package/build/src/plugins/workspace.js

@@ -32,10 +32,11 @@ const release_please_manifest_1 = require("../updaters/release-please-manifest")
  */
 class WorkspacePlugin extends plugin_1.ManifestPlugin {
     constructor(github, targetBranch, repositoryConfig, options = {}) {
-        var _a, _b;
+        var _a, _b, _c;
         super(github, targetBranch, repositoryConfig);
         this.manifestPath = (_a = options.manifestPath) !== null && _a !== void 0 ? _a : manifest_1.DEFAULT_RELEASE_PLEASE_MANIFEST;
         this.updateAllPackages = (_b = options.updateAllPackages) !== null && _b !== void 0 ? _b : false;
+        this.merge = (_c = options.merge) !== null && _c !== void 0 ? _c : true;
     }
     async run(candidates) {
         logger_1.logger.info('Running workspace plugin');
@@ -100,23 +101,20 @@ class WorkspacePlugin extends plugin_1.ManifestPlugin {
                 newCandidates.push(newCandidate);
             }
         }
-        logger_1.logger.info(`Merging ${newCandidates.length} in-scope candidates`);
-        const mergePlugin = new merge_1.Merge(this.github, this.targetBranch, this.repositoryConfig);
-        newCandidates = await mergePlugin.run(newCandidates);
-        if (newCandidates.length === 1) {
-            const newUpdates = newCandidates[0].pullRequest.updates;
-            newUpdates.push({
-                path: this.manifestPath,
-                createIfMissing: false,
-                updater: new release_please_manifest_1.ReleasePleaseManifest({
-                    version: newCandidates[0].pullRequest.version,
-                    versionsMap: updatedPathVersions,
-                }),
-            });
-        }
-        else {
-            logger_1.logger.warn(`Expected 1 merged candidate, got ${newCandidates.length}`);
+        if (this.merge) {
+            logger_1.logger.info(`Merging ${newCandidates.length} in-scope candidates`);
+            const mergePlugin = new merge_1.Merge(this.github, this.targetBranch, this.repositoryConfig);
+            newCandidates = await mergePlugin.run(newCandidates);
         }
+        const newUpdates = newCandidates[0].pullRequest.updates;
+        newUpdates.push({
+            path: this.manifestPath,
+            createIfMissing: false,
+            updater: new release_please_manifest_1.ReleasePleaseManifest({
+                version: newCandidates[0].pullRequest.version,
+                versionsMap: updatedPathVersions,
+            }),
+        });
         logger_1.logger.info(`Post-processing ${newCandidates.length} in-scope candidates`);
         newCandidates = this.postProcessCandidates(newCandidates, updatedVersions);
         return [...outOfScopeCandidates, ...newCandidates];

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

@@ -43,6 +43,7 @@ export interface BaseStrategyOptions {
     extraFiles?: ExtraFile[];
     versionFile?: string;
     snapshotLabels?: string[];
+    skipSnapshot?: boolean;
 }
 /**
  * A strategy is responsible for determining which files are

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

@@ -16,6 +16,7 @@ export interface JavaBuildUpdatesOption extends BuildUpdatesOptions {
 export declare class Java extends BaseStrategy {
     protected readonly snapshotVersioning: VersioningStrategy;
     protected readonly snapshotLabels: string[];
+    readonly skipSnapshot: boolean;
     constructor(options: BaseStrategyOptions);
     buildReleasePullRequest(commits: Commit[], latestRelease?: Release, draft?: boolean, labels?: string[]): Promise<ReleasePullRequest | undefined>;
     protected buildSnapshotPullRequest(latestRelease?: Release, draft?: boolean, labels?: string[]): Promise<ReleasePullRequest>;

package/build/src/strategies/java.js

@@ -47,7 +47,7 @@ const CHANGELOG_SECTIONS = [
  */
 class Java extends base_1.BaseStrategy {
     constructor(options) {
-        var _a;
+        var _a, _b;
         options.changelogSections = (_a = options.changelogSections) !== null && _a !== void 0 ? _a : CHANGELOG_SECTIONS;
         // wrap the configured versioning strategy with snapshotting
         const parentVersioningStrategy = options.versioningStrategy || new default_1.DefaultVersioningStrategy();
@@ -55,6 +55,7 @@ class Java extends base_1.BaseStrategy {
         super(options);
         this.snapshotVersioning = new java_add_snapshot_1.JavaAddSnapshot(parentVersioningStrategy);
         this.snapshotLabels = options.snapshotLabels || manifest_1.DEFAULT_SNAPSHOT_LABELS;
+        this.skipSnapshot = (_b = options.skipSnapshot) !== null && _b !== void 0 ? _b : false;
     }
     async buildReleasePullRequest(commits, latestRelease, draft, labels = []) {
         if (await this.needsSnapshot(commits, latestRelease)) {
@@ -107,6 +108,9 @@ class Java extends base_1.BaseStrategy {
     }
     async needsSnapshot(commits, latestRelease) {
         var _a;
+        if (this.skipSnapshot) {
+            return false;
+        }
         const component = await this.getComponent();
         logger_1.logger.debug('component:', component);
         const version = (_a = latestRelease === null || latestRelease === void 0 ? void 0 : latestRelease.tag) === null || _a === void 0 ? void 0 : _a.version;

package/build/src/updaters/php/root-composer-update-packages.js

@@ -33,11 +33,18 @@ class RootComposerUpdatePackages extends default_1.DefaultUpdater {
         }
         const parsed = JSON.parse(content);
         if (this.versionsMap) {
-            // eslint-disable-next-line prefer-const
-            for (let [key, version] of this.versionsMap.entries()) {
-                version = version || '1.0.0';
-                logger_1.logger.info(`updating ${key} from ${parsed.replace[key]} to ${version}`);
-                parsed.replace[key] = version.toString();
+            for (const [key, version] of this.versionsMap.entries()) {
+                const toVersion = version.toString() || '1.0.0';
+                let fromVersion;
+                if (parsed.replace) {
+                    fromVersion = parsed.replace[key];
+                    parsed.replace[key] = toVersion;
+                }
+                if (parsed[key]) {
+                    fromVersion !== null && fromVersion !== void 0 ? fromVersion : (fromVersion = parsed[key]);
+                    parsed[key] = toVersion;
+                }
+                logger_1.logger.info(`updating ${key} from ${fromVersion} to ${toVersion}`);
             }
         }
         return (0, json_stringify_1.jsonStringify)(parsed, content);

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

@@ -28,7 +28,7 @@ class ReleasePleaseConfig {
         else {
             parsed = { packages: {} };
         }
-        parsed.packages[this.path] = this.config;
+        parsed.packages[this.path] = releaserConfigToJsonConfig(this.config);
         if (content) {
             return (0, json_stringify_1.jsonStringify)(parsed, content);
         }
@@ -38,4 +38,34 @@ class ReleasePleaseConfig {
     }
 }
 exports.ReleasePleaseConfig = ReleasePleaseConfig;
+function releaserConfigToJsonConfig(config) {
+    var _a, _b, _c;
+    const jsonConfig = {
+        'package-name': config.packageName,
+        component: config.component,
+        'changelog-path': config.changelogPath,
+        'release-type': config.releaseType,
+        'bump-minor-pre-major': config.bumpMinorPreMajor,
+        'bump-patch-for-minor-pre-major': config.bumpPatchForMinorPreMajor,
+        'changelog-sections': config.changelogSections,
+        'release-as': config.releaseAs,
+        'skip-github-release': config.skipGithubRelease,
+        draft: config.draft,
+        prerelease: config.prerelease,
+        'draft-pull-request': config.draftPullRequest,
+        label: (_a = config.labels) === null || _a === void 0 ? void 0 : _a.join(','),
+        'release-label': (_b = config.releaseLabels) === null || _b === void 0 ? void 0 : _b.join(','),
+        'include-component-in-tag': config.includeComponentInTag,
+        'include-v-in-tag': config.includeVInTag,
+        'changelog-type': config.changelogType,
+        'changelog-host': config.changelogHost,
+        'pull-request-title-pattern': config.pullRequestTitlePattern,
+        'separate-pull-requests': config.separatePullRequests,
+        'tag-separator': config.tagSeparator,
+        'extra-files': config.extraFiles,
+        'version-file': config.versionFile,
+        'snapshot-label': (_c = config.snapshotLabels) === null || _c === void 0 ? void 0 : _c.join(','), // Java-only
+    };
+    return jsonConfig;
+}
 //# sourceMappingURL=release-please-config.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "release-please",
-  "version": "13.19.7",
+  "version": "13.20.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

@@ -171,6 +171,10 @@
         "snapshot-label": {
           "description": "Label to add to snapshot pull request. Used by `java` strategies.",
           "type": "string"
+        },
+        "skip-snapshot": {
+          "description": "If set, do not propose snapshot pull requests. Used by `java` strategies.",
+          "type": "boolean"
         }
       }
     }
@@ -228,10 +232,33 @@
                     "items": {
                       "type": "string"
                     }
+                  },
+                  "merge": {
+                    "description": "Whether to merge in-scope pull requests into a combined release pull request. Defaults to `true`.",
+                    "type": "boolean"
                   }
                 },
                 "required": ["type", "groupName", "components"]
               },
+              {
+                "description": "Configuration for various `workspace` plugins.",
+                "type": "object",
+                "properties": {
+                  "type": {
+                    "description": "The name of the plugin.",
+                    "type": "string",
+                    "enum": ["cargo-workspace", "maven-workspace", "node-workspace"]
+                  },
+                  "updateAllPackages": {
+                    "description": "Whether to force updating all packages regardless of the dependency tree. Defaults to `false`.",
+                    "type": "boolean"
+                  },
+                  "merge": {
+                    "description": "Whether to merge in-scope pull requests into a combined release pull request. Defaults to `true`.",
+                    "type": "boolean"
+                  }
+                }
+              },
               {
                 "description": "Other plugins",
                 "type": "object",