release-please 13.16.1 → 13.16.4

package/CHANGELOG.md

@@ -4,6 +4,45 @@
 
 [1]: https://www.npmjs.com/package/release-please?activeTab=versions
 
+### [13.16.4](https://github.com/googleapis/release-please/compare/v13.16.3...v13.16.4) (2022-05-17)
+
+
+### Bug Fixes
+
+* add release labels if release PR was completed ([#1433](https://github.com/googleapis/release-please/issues/1433)) ([072498c](https://github.com/googleapis/release-please/commit/072498c8ce2f89bc86eb33445d87491e3ab31fbd))
+* CommitSplit with includeEmpty should add commit to all packages ([#1432](https://github.com/googleapis/release-please/issues/1432)) ([19629cb](https://github.com/googleapis/release-please/commit/19629cb42da625d6c62e67f1e9edf7f3cf14d6ee)), closes [#1360](https://github.com/googleapis/release-please/issues/1360)
+* Manifest.fromConfig should find branch component ([#1436](https://github.com/googleapis/release-please/issues/1436)) ([628a562](https://github.com/googleapis/release-please/commit/628a562a21245ed02546aa0c40c97a0e3d50a0c7))
+
+### [13.16.3](https://github.com/googleapis/release-please/compare/v13.16.2...v13.16.3) (2022-05-17)
+
+
+### Bug Fixes
+
+* add release labels if release PR was completed ([#1433](https://github.com/googleapis/release-please/issues/1433)) ([072498c](https://github.com/googleapis/release-please/commit/072498c8ce2f89bc86eb33445d87491e3ab31fbd))
+* CommitSplit with includeEmpty should add commit to all packages ([#1432](https://github.com/googleapis/release-please/issues/1432)) ([19629cb](https://github.com/googleapis/release-please/commit/19629cb42da625d6c62e67f1e9edf7f3cf14d6ee)), closes [#1360](https://github.com/googleapis/release-please/issues/1360)
+* workspace plugins should update manifest versions ([#1429](https://github.com/googleapis/release-please/issues/1429)) ([ab802a9](https://github.com/googleapis/release-please/commit/ab802a924704044b26017b40a2da48657022faad))
+
+### [13.16.3](https://github.com/googleapis/release-please/compare/v13.16.2...v13.16.3) (2022-05-13)
+
+
+### Bug Fixes
+
+* workspace plugins should update manifest versions ([#1429](https://github.com/googleapis/release-please/issues/1429)) ([ab802a9](https://github.com/googleapis/release-please/commit/ab802a924704044b26017b40a2da48657022faad))
+
+### [13.16.3](https://github.com/googleapis/release-please/compare/v13.16.2...v13.16.3) (2022-05-13)
+
+
+### Bug Fixes
+
+* workspace plugins should update manifest versions ([#1429](https://github.com/googleapis/release-please/issues/1429)) ([ab802a9](https://github.com/googleapis/release-please/commit/ab802a924704044b26017b40a2da48657022faad))
+
+### [13.16.2](https://github.com/googleapis/release-please/compare/v13.16.1...v13.16.2) (2022-05-12)
+
+
+### Bug Fixes
+
+* throw ConfigurationError when required manifest config file is missing ([#1422](https://github.com/googleapis/release-please/issues/1422)) ([83e461e](https://github.com/googleapis/release-please/commit/83e461e8947d16fbd92d57a0d9c64d37ab0dfa42))
+
 ### [13.16.1](https://github.com/googleapis/release-please/compare/v13.16.0...v13.16.1) (2022-05-10)
 
 

package/build/src/factories/plugin-factory.d.ts

@@ -7,6 +7,7 @@ export interface PluginFactoryOptions {
     github: GitHub;
     targetBranch: string;
     repositoryConfig: RepositoryConfig;
+    manifestPath: string;
     alwaysLinkLocal?: boolean;
     updateAllPackages?: boolean;
 }

package/build/src/manifest.js

@@ -145,9 +145,9 @@ class Manifest {
             github,
             ...config,
         });
-        const component = await strategy.getComponent();
+        const component = await strategy.getBranchComponent();
         const releasedVersions = {};
-        const latestVersion = await latestReleaseVersion(github, targetBranch, version => isPublishedVersion(strategy, version), config.includeComponentInTag ? component : '', config.pullRequestTitlePattern);
+        const latestVersion = await latestReleaseVersion(github, targetBranch, version => isPublishedVersion(strategy, version), component, config.pullRequestTitlePattern);
         if (latestVersion) {
             releasedVersions[path] = latestVersion;
         }
@@ -314,6 +314,7 @@ class Manifest {
             github: this.github,
             targetBranch: this.targetBranch,
             repositoryConfig: this.repositoryConfig,
+            manifestPath: this.manifestPath,
         }));
         let strategies = strategiesByPath;
         for (const plugin of plugins) {
@@ -603,20 +604,16 @@ class Manifest {
         }
     }
     async createReleasesForPullRequest(releases, pullRequest) {
-        // create the release
-        const promises = [];
-        for (const release of releases) {
-            promises.push(this.createRelease(release));
-        }
+        logger_1.logger.info(`Creating ${releases.length} releases for pull #${pullRequest.number}`);
         const duplicateReleases = [];
         const githubReleases = [];
-        for (const promise of promises) {
+        for (const release of releases) {
             try {
-                githubReleases.push(await promise);
+                githubReleases.push(await this.createRelease(release));
             }
             catch (err) {
                 if (err instanceof errors_1.DuplicateReleaseError) {
-                    logger_1.logger.warn(`Duplicate release tag: ${err.tag}`);
+                    logger_1.logger.warn(`Duplicate release tag: ${release.tag.toString()}`);
                     duplicateReleases.push(err);
                 }
                 else {
@@ -624,14 +621,28 @@ class Manifest {
                 }
             }
         }
-        if (duplicateReleases.length > 0 && githubReleases.length === 0) {
-            throw duplicateReleases[0];
+        if (duplicateReleases.length > 0) {
+            if (duplicateReleases.length + githubReleases.length ===
+                releases.length) {
+                // we've either tagged all releases or they were duplicates:
+                // adjust tags on pullRequest
+                await Promise.all([
+                    this.github.removeIssueLabels(this.labels, pullRequest.number),
+                    this.github.addIssueLabels(this.releaseLabels, pullRequest.number),
+                ]);
+            }
+            if (githubReleases.length === 0) {
+                // If all releases were duplicate, throw a duplicate error
+                throw duplicateReleases[0];
+            }
+        }
+        else {
+            // adjust tags on pullRequest
+            await Promise.all([
+                this.github.removeIssueLabels(this.labels, pullRequest.number),
+                this.github.addIssueLabels(this.releaseLabels, pullRequest.number),
+            ]);
         }
-        // adjust tags on pullRequest
-        await Promise.all([
-            this.github.removeIssueLabels(this.labels, pullRequest.number),
-            this.github.addIssueLabels(this.releaseLabels, pullRequest.number),
-        ]);
         return githubReleases;
     }
     async createRelease(release) {
@@ -729,7 +740,7 @@ function extractReleaserConfig(config) {
  * @param {string} releaseAs Optional. Override release-as and use the given version
  */
 async function parseConfig(github, configFile, branch, onlyPath, releaseAs) {
-    const config = await github.getFileJson(configFile, branch);
+    const config = await fetchManifestConfig(github, configFile, branch);
     const defaultConfig = extractReleaserConfig(config);
     const repositoryConfig = {};
     for (const path in config.packages) {
@@ -759,21 +770,61 @@ async function parseConfig(github, configFile, branch, onlyPath, releaseAs) {
     };
     return { config: repositoryConfig, options: manifestOptions };
 }
+/**
+ * Helper to fetch manifest config
+ *
+ * @param {GitHub} github
+ * @param {string} configFile
+ * @param {string} branch
+ * @returns {ManifestConfig}
+ * @throws {ConfigurationError} if missing the manifest config file
+ */
+async function fetchManifestConfig(github, configFile, branch) {
+    try {
+        return await github.getFileJson(configFile, branch);
+    }
+    catch (e) {
+        if (e instanceof errors_1.FileNotFoundError) {
+            throw new errors_1.ConfigurationError(`Missing required manifest config: ${configFile}`, 'base', `${github.repository.owner}/${github.repository.repo}`);
+        }
+        throw e;
+    }
+}
 /**
  * Helper to parse the manifest versions file.
  *
  * @param {GitHub} github GitHub client
  * @param {string} manifestFile Path in the repository to the versions file
  * @param {string} branch Branch to fetch the versions file from
+ * @returns {Record<string, string>}
  */
 async function parseReleasedVersions(github, manifestFile, branch) {
-    const manifestJson = await github.getFileJson(manifestFile, branch);
+    const manifestJson = await fetchReleasedVersions(github, manifestFile, branch);
     const releasedVersions = {};
     for (const path in manifestJson) {
         releasedVersions[path] = version_1.Version.parse(manifestJson[path]);
     }
     return releasedVersions;
 }
+/**
+ * Helper to fetch manifest config
+ *
+ * @param {GitHub} github
+ * @param {string} manifestFile
+ * @param {string} branch
+ * @throws {ConfigurationError} if missing the manifest config file
+ */
+async function fetchReleasedVersions(github, manifestFile, branch) {
+    try {
+        return await github.getFileJson(manifestFile, branch);
+    }
+    catch (e) {
+        if (e instanceof errors_1.FileNotFoundError) {
+            throw new errors_1.ConfigurationError(`Missing required manifest versions: ${manifestFile}`, 'base', `${github.repository.owner}/${github.repository.repo}`);
+        }
+        throw e;
+    }
+}
 function isPublishedVersion(strategy, version) {
     return strategy.isPublishedVersion
         ? strategy.isPublishedVersion(version)

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

@@ -47,5 +47,6 @@ export declare class CargoWorkspace extends WorkspacePlugin<CrateInfo> {
     protected buildGraph(allPackages: CrateInfo[]): Promise<DependencyGraph<CrateInfo>>;
     protected inScope(candidate: CandidateReleasePullRequest): boolean;
     protected packageNameFromPackage(pkg: CrateInfo): string;
+    protected pathFromPackage(pkg: CrateInfo): string;
 }
 export {};

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

@@ -213,6 +213,9 @@ class CargoWorkspace extends workspace_1.WorkspacePlugin {
     packageNameFromPackage(pkg) {
         return pkg.name;
     }
+    pathFromPackage(pkg) {
+        return pkg.path;
+    }
 }
 exports.CargoWorkspace = CargoWorkspace;
 function getChangelogDepsNotes(originalManifest, updatedManifest) {

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

@@ -33,5 +33,6 @@ export declare class NodeWorkspace extends WorkspacePlugin<Package> {
     protected buildGraph(allPackages: Package[]): Promise<DependencyGraph<Package>>;
     protected inScope(candidate: CandidateReleasePullRequest): boolean;
     protected packageNameFromPackage(pkg: Package): string;
+    protected pathFromPackage(pkg: Package): string;
 }
 export {};

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

@@ -235,6 +235,9 @@ class NodeWorkspace extends workspace_1.WorkspacePlugin {
     packageNameFromPackage(pkg) {
         return pkg.name;
     }
+    pathFromPackage(pkg) {
+        return pkg.location;
+    }
 }
 exports.NodeWorkspace = NodeWorkspace;
 function getChangelogDepsNotes(original, updated) {

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

@@ -8,6 +8,7 @@ export interface DependencyNode<T> {
     value: T;
 }
 export interface WorkspacePluginOptions {
+    manifestPath?: string;
     updateAllPackages?: boolean;
 }
 interface AllPackages<T> {
@@ -27,6 +28,7 @@ interface AllPackages<T> {
  */
 export declare abstract class WorkspacePlugin<T> extends ManifestPlugin {
     private updateAllPackages;
+    private manifestPath;
     constructor(github: GitHub, targetBranch: string, repositoryConfig: RepositoryConfig, options?: WorkspacePluginOptions);
     run(candidates: CandidateReleasePullRequest[]): Promise<CandidateReleasePullRequest[]>;
     /**
@@ -83,6 +85,12 @@ export declare abstract class WorkspacePlugin<T> extends ManifestPlugin {
      * @returns {string} The package name.
      */
     protected abstract packageNameFromPackage(pkg: T): string;
+    /**
+     * Given a package, return the path in the repo to the package.
+     * @param {T} pkg The package definition.
+     * @returns {string} The package path.
+     */
+    protected abstract pathFromPackage(pkg: T): string;
     /**
      * Amend any or all in-scope candidates once all other processing has occured.
      *

package/build/src/plugins/workspace.js

@@ -15,8 +15,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.WorkspacePlugin = void 0;
 const plugin_1 = require("../plugin");
+const manifest_1 = require("../manifest");
 const logger_1 = require("../util/logger");
 const merge_1 = require("./merge");
+const release_please_manifest_1 = require("../updaters/release-please-manifest");
 /**
  * The plugin generalizes the logic for handling a workspace and
  * will bump dependencies of managed packages if those dependencies
@@ -30,9 +32,10 @@ const merge_1 = require("./merge");
  */
 class WorkspacePlugin extends plugin_1.ManifestPlugin {
     constructor(github, targetBranch, repositoryConfig, options = {}) {
-        var _a;
+        var _a, _b;
         super(github, targetBranch, repositoryConfig);
-        this.updateAllPackages = (_a = options.updateAllPackages) !== null && _a !== void 0 ? _a : false;
+        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;
     }
     async run(candidates) {
         logger_1.logger.info('Running workspace plugin');
@@ -63,6 +66,7 @@ class WorkspacePlugin extends plugin_1.ManifestPlugin {
         const orderedPackages = this.buildGraphOrder(graph, packageNamesToUpdate);
         logger_1.logger.info(`Updating ${orderedPackages.length} packages`);
         const updatedVersions = new Map();
+        const updatedPathVersions = new Map();
         for (const pkg of orderedPackages) {
             const packageName = this.packageNameFromPackage(pkg);
             logger_1.logger.debug(`package: ${packageName}`);
@@ -76,6 +80,7 @@ class WorkspacePlugin extends plugin_1.ManifestPlugin {
                 const version = this.bumpVersion(pkg);
                 logger_1.logger.debug(`version: ${version} forced bump`);
                 updatedVersions.set(packageName, version);
+                updatedPathVersions.set(this.pathFromPackage(pkg), version);
             }
         }
         let newCandidates = [];
@@ -98,6 +103,20 @@ class WorkspacePlugin extends plugin_1.ManifestPlugin {
         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}`);
+        }
         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

@@ -79,7 +79,7 @@ export declare abstract class BaseStrategy implements Strategy {
      */
     getComponent(): Promise<string | undefined>;
     getDefaultComponent(): Promise<string | undefined>;
-    protected getBranchComponent(): Promise<string | undefined>;
+    getBranchComponent(): Promise<string | undefined>;
     getPackageName(): Promise<string | undefined>;
     getDefaultPackageName(): Promise<string | undefined>;
     protected normalizeComponent(component: string | undefined): string;

package/build/src/strategy.d.ts

@@ -36,6 +36,12 @@ export interface Strategy {
      * @returns {string}
      */
     getComponent(): Promise<string | undefined>;
+    /**
+     * Return the component for this strategy used in the branch name.
+     * This may be a computed field.
+     * @returns {string}
+     */
+    getBranchComponent(): Promise<string | undefined>;
     /**
      * Validate whether version is a valid release.
      * @param version Released version.

package/build/src/util/commit-split.d.ts

@@ -3,9 +3,24 @@ export interface CommitSplitOptions {
     includeEmpty?: boolean;
     packagePaths?: string[];
 }
+/**
+ * Helper class for splitting commits by component path. If `packagePaths`
+ * is configured, then only consider the provided paths. If `includeEmpty`
+ * is configured, then commits without any touched files apply to all
+ * configured component paths.
+ */
 export declare class CommitSplit {
     includeEmpty: boolean;
     packagePaths?: string[];
     constructor(opts?: CommitSplitOptions);
+    /**
+     * Split commits by component path. If the commit splitter is configured
+     * with a set of tracked package paths, then only consider paths for
+     * configured components. If `includeEmpty` is configured, then a commit
+     * that does not touch any files will be applied to all components'
+     * commits.
+     * @param {Commit[]} commits The commits to split
+     * @returns {Record<string, Commit[]>} Commits indexed by component path
+     */
     split<T extends Commit>(commits: T[]): Record<string, T[]>;
 }

package/build/src/util/commit-split.js

@@ -15,6 +15,12 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CommitSplit = void 0;
 const manifest_1 = require("../manifest");
+/**
+ * Helper class for splitting commits by component path. If `packagePaths`
+ * is configured, then only consider the provided paths. If `includeEmpty`
+ * is configured, then commits without any touched files apply to all
+ * configured component paths.
+ */
 class CommitSplit {
     constructor(opts) {
         opts = opts || {};
@@ -50,7 +56,15 @@ class CommitSplit {
             this.packagePaths = paths;
         }
     }
-    // split(commits: Commit[]): Record<string, Commit[]>
+    /**
+     * Split commits by component path. If the commit splitter is configured
+     * with a set of tracked package paths, then only consider paths for
+     * configured components. If `includeEmpty` is configured, then a commit
+     * that does not touch any files will be applied to all components'
+     * commits.
+     * @param {Commit[]} commits The commits to split
+     * @returns {Record<string, Commit[]>} Commits indexed by component path
+     */
     split(commits) {
         const splitCommits = {};
         commits.forEach(commit => {
@@ -85,8 +99,16 @@ class CommitSplit {
                 splitCommits[pkgName].push(commit);
             }
             if (commit.files.length === 0 && this.includeEmpty) {
-                for (const pkgName in splitCommits) {
-                    splitCommits[pkgName].push(commit);
+                if (this.packagePaths) {
+                    for (const pkgName of this.packagePaths) {
+                        splitCommits[pkgName] = splitCommits[pkgName] || [];
+                        splitCommits[pkgName].push(commit);
+                    }
+                }
+                else {
+                    for (const pkgName in splitCommits) {
+                        splitCommits[pkgName].push(commit);
+                    }
                 }
             }
         });

package/package.json

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