release-please 13.1.0 → 13.1.1

package/CHANGELOG.md

@@ -4,6 +4,13 @@
 
 [1]: https://www.npmjs.com/package/release-please?activeTab=versions
 
+### [13.1.1](https://www.github.com/googleapis/release-please/compare/v13.1.0...v13.1.1) (2022-01-03)
+
+
+### Bug Fixes
+
+* **rust:** Rust strategy should update root Cargo files in a workspace ([#1182](https://www.github.com/googleapis/release-please/issues/1182)) ([26a040c](https://www.github.com/googleapis/release-please/commit/26a040cf06a7a2cf97b9ebc3d204bb36f0b2c13b)), closes [#1170](https://www.github.com/googleapis/release-please/issues/1170) [#1096](https://www.github.com/googleapis/release-please/issues/1096)
+
 ## [13.1.0](https://www.github.com/googleapis/release-please/compare/v13.0.2...v13.1.0) (2021-12-29)
 
 

package/README.md

@@ -91,6 +91,24 @@ chore: release 2.0.0
 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
+used to generate the release notes for that commit, you can edit the body of
+the merged pull requests and add a section like:
+
+```
+BEGIN_COMMIT_OVERRIDE
+feat: add ability to override merged commit message
+
+fix: another message
+chore: a third message
+END_COMMIT_OVERRIDE
+```
+
+The next time release please runs, it will use that override section as the
+commit message instead of the merged commit message.
+
 ## Strategy (Language) types supported
 
 Release Please automates releases for the following flavors of repositories:

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

@@ -26,6 +26,7 @@ const pull_request_title_1 = require("../util/pull-request-title");
 const pull_request_body_1 = require("../util/pull-request-body");
 const branch_name_1 = require("../util/branch-name");
 const versioning_strategy_1 = require("../versioning-strategy");
+const cargo_lock_1 = require("../updaters/rust/cargo-lock");
 /**
  * The plugin analyzed a cargo workspace and will bump dependencies
  * of managed packages if those dependencies are being updated.
@@ -50,7 +51,9 @@ class CargoWorkspace extends workspace_1.WorkspacePlugin {
         }
         const allCrates = [];
         const candidatesByPackage = {};
-        for (const path of cargoManifest.workspace.members) {
+        const members = cargoManifest.workspace.members;
+        members.push(manifest_1.ROOT_PROJECT_PATH);
+        for (const path of members) {
             const manifestPath = addPath(path, 'Cargo.toml');
             logger_1.logger.info(`looking for candidate with path: ${path}`);
             const candidate = candidates.find(c => c.path === path);
@@ -60,7 +63,8 @@ class CargoWorkspace extends workspace_1.WorkspacePlugin {
             const manifest = common_1.parseCargoManifest(manifestContent.parsedContent);
             const packageName = (_c = manifest.package) === null || _c === void 0 ? void 0 : _c.name;
             if (!packageName) {
-                throw new Error(`package manifest at ${manifestPath} is missing [package.name]`);
+                logger_1.logger.warn(`package manifest at ${manifestPath} is missing [package.name]`);
+                continue;
             }
             if (candidate) {
                 candidatesByPackage[packageName] = candidate;
@@ -105,9 +109,15 @@ class CargoWorkspace extends workspace_1.WorkspacePlugin {
                 if (update.path === addPath(existingCandidate.path, 'Cargo.toml')) {
                     update.updater = new raw_content_1.RawContent(updatedContent);
                 }
-                else if (update.updater instanceof changelog_1.Changelog) {
+                else if (update.updater instanceof changelog_1.Changelog && dependencyNotes) {
                     update.updater.changelogEntry = appendDependenciesSectionToChangelog(update.updater.changelogEntry, dependencyNotes);
                 }
+                else if (update.path === addPath(existingCandidate.path, 'Cargo.lock')) {
+                    update.updater = new cargo_lock_1.CargoLock({
+                        version,
+                        versionsMap: updatedVersions,
+                    });
+                }
                 return update;
             });
         // append dependency notes
@@ -195,8 +205,7 @@ class CargoWorkspace extends workspace_1.WorkspacePlugin {
         return graph;
     }
     inScope(candidate) {
-        return (candidate.config.releaseType === 'rust' &&
-            candidate.path !== manifest_1.ROOT_PROJECT_PATH);
+        return candidate.config.releaseType === 'rust';
     }
     packageNameFromPackage(pkg) {
         return pkg.name;

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

@@ -12,9 +12,6 @@ export declare class Rust extends BaseStrategy {
      * @returns the package's manifest, ie. `crates/foobar/Cargo.toml`
      */
     protected getPackageManifest(): Promise<CargoManifest | null>;
-    /**
-     * @returns the workspace's manifest, ie. `Cargo.toml` (top-level)
-     */
-    protected getWorkspaceManifest(): Promise<CargoManifest | null>;
+    private getContent;
     protected getManifest(path: string): Promise<CargoManifest | null>;
 }

package/build/src/strategies/rust.js

@@ -25,6 +25,7 @@ const base_1 = require("./base");
 const version_1 = require("../version");
 class Rust extends base_1.BaseStrategy {
     async buildUpdates(options) {
+        var _a, _b, _c;
         const updates = [];
         const version = options.newVersion;
         updates.push({
@@ -35,30 +36,62 @@ class Rust extends base_1.BaseStrategy {
                 changelogEntry: options.changelogEntry,
             }),
         });
-        const workspaceManifest = await this.getWorkspaceManifest();
-        const manifestPaths = [];
-        let lockPath;
-        if (workspaceManifest &&
-            workspaceManifest.workspace &&
-            workspaceManifest.workspace.members) {
+        const workspaceManifest = await this.getPackageManifest();
+        const versionsMap = new Map();
+        if ((_a = workspaceManifest === null || workspaceManifest === void 0 ? void 0 : workspaceManifest.workspace) === null || _a === void 0 ? void 0 : _a.members) {
             const members = workspaceManifest.workspace.members;
+            if ((_b = workspaceManifest.package) === null || _b === void 0 ? void 0 : _b.name) {
+                versionsMap.set(workspaceManifest.package.name, version);
+            }
+            else {
+                logger_1.logger.warn('No workspace manifest package name found');
+            }
             logger_1.logger.info(`found workspace with ${members.length} members, upgrading all`);
+            // Collect submodule names to update
+            const manifestsByPath = new Map();
             for (const member of members) {
-                manifestPaths.push(`${member}/Cargo.toml`);
+                const manifestPath = `${member}/Cargo.toml`;
+                const manifestContent = await this.getContent(manifestPath);
+                if (!manifestContent) {
+                    logger_1.logger.warn(`member ${member} declared but did not find Cargo.toml`);
+                    continue;
+                }
+                const manifest = common_1.parseCargoManifest(manifestContent.parsedContent);
+                manifestsByPath.set(manifestPath, manifestContent);
+                if (!((_c = manifest.package) === null || _c === void 0 ? void 0 : _c.name)) {
+                    logger_1.logger.warn(`member ${member} has no package name`);
+                    continue;
+                }
+                versionsMap.set(manifest.package.name, version);
             }
-            lockPath = 'Cargo.lock';
+            logger_1.logger.info(`updating ${manifestsByPath.size} submodules`);
+            logger_1.logger.debug('versions map:', versionsMap);
+            for (const [manifestPath, manifestContent] of manifestsByPath) {
+                updates.push({
+                    path: this.addPath(manifestPath),
+                    createIfMissing: false,
+                    cachedFileContents: manifestContent,
+                    updater: new cargo_toml_1.CargoToml({
+                        version,
+                        versionsMap,
+                    }),
+                });
+            }
+            // Update root Cargo.toml
+            updates.push({
+                path: this.addPath('Cargo.toml'),
+                createIfMissing: false,
+                updater: new cargo_toml_1.CargoToml({
+                    version,
+                    versionsMap,
+                }),
+            });
         }
         else {
             const manifestPath = this.addPath('Cargo.toml');
             logger_1.logger.info(`single crate found, updating ${manifestPath}`);
-            manifestPaths.push(manifestPath);
-            lockPath = this.addPath('Cargo.lock');
-        }
-        const versionsMap = new Map();
-        versionsMap.set(this.component || '', version);
-        for (const path of manifestPaths) {
             updates.push({
-                path,
+                path: manifestPath,
                 createIfMissing: false,
                 updater: new cargo_toml_1.CargoToml({
                     version,
@@ -67,7 +100,7 @@ class Rust extends base_1.BaseStrategy {
             });
         }
         updates.push({
-            path: lockPath,
+            path: this.addPath('Cargo.lock'),
             createIfMissing: false,
             updater: new cargo_lock_1.CargoLock({
                 version,
@@ -92,28 +125,21 @@ class Rust extends base_1.BaseStrategy {
      */
     async getPackageManifest() {
         if (this.packageManifest === undefined) {
-            this.packageManifest = await this.getManifest(this.addPath('Cargo.toml'));
+            this.packageManifest = await this.getManifest('Cargo.toml');
         }
         return this.packageManifest;
     }
-    /**
-     * @returns the workspace's manifest, ie. `Cargo.toml` (top-level)
-     */
-    async getWorkspaceManifest() {
-        if (this.workspaceManifest === undefined) {
-            this.workspaceManifest = await this.getManifest('Cargo.toml');
-        }
-        return this.workspaceManifest;
-    }
-    async getManifest(path) {
-        let content;
+    async getContent(path) {
         try {
-            content = await this.github.getFileContentsOnBranch(path, this.targetBranch);
+            return await this.github.getFileContentsOnBranch(this.addPath(path), this.targetBranch);
         }
         catch (e) {
             return null;
         }
-        return common_1.parseCargoManifest(content.parsedContent);
+    }
+    async getManifest(path) {
+        const content = await this.getContent(path);
+        return content ? common_1.parseCargoManifest(content.parsedContent) : null;
     }
 }
 exports.Rust = Rust;

package/build/src/updaters/rust/cargo-toml.js

@@ -28,7 +28,6 @@ class CargoToml extends default_1.DefaultUpdater {
      * @returns {string} The updated content
      */
     updateContent(content) {
-        var _a;
         let payload = content;
         if (!this.versionsMap) {
             throw new Error('updateContent called with no versions');
@@ -39,12 +38,8 @@ class CargoToml extends default_1.DefaultUpdater {
             logger_1.logger.error(msg);
             throw new Error(msg);
         }
+        payload = toml_edit_1.replaceTomlValue(payload, ['package', 'version'], this.version.toString());
         for (const [pkgName, pkgVersion] of this.versionsMap) {
-            if (parsed.package.name === pkgName) {
-                logger_1.logger.info(`updating own version from ${(_a = parsed.package) === null || _a === void 0 ? void 0 : _a.version} to ${pkgVersion}`);
-                payload = toml_edit_1.replaceTomlValue(payload, ['package', 'version'], pkgVersion.toString());
-                continue; // to next [pkgName, pkgVersion] pair
-            }
             for (const depKind of common_1.DEP_KINDS) {
                 const deps = parsed[depKind];
                 if (!deps) {

package/package.json

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