release-please 16.14.4 → 16.16.0

package/CHANGELOG.md

@@ -4,6 +4,25 @@
 
 [1]: https://www.npmjs.com/package/release-please?activeTab=versions
 
+## [16.16.0](https://github.com/googleapis/release-please/compare/v16.15.0...v16.16.0) (2025-02-19)
+
+
+### Features
+
+* add strategy for R packages ([#2436](https://github.com/googleapis/release-please/issues/2436)) ([2b5ff3b](https://github.com/googleapis/release-please/commit/2b5ff3b5d7b5c8546bb112149908e150e9eba680))
+
+
+### Bug Fixes
+
+* **deps:** bump dependency versions ([#2486](https://github.com/googleapis/release-please/issues/2486)) ([6db2fb4](https://github.com/googleapis/release-please/commit/6db2fb48adcdf60f1779601fb36f982e2fb7f6f7))
+
+## [16.15.0](https://github.com/googleapis/release-please/compare/v16.14.4...v16.15.0) (2024-11-13)
+
+
+### Features
+
+* add `always-update` option to push to always push to release branch ([72d40df](https://github.com/googleapis/release-please/commit/72d40df677b08fd52654a4c3b320649f63b9c635))
+
 ## [16.14.4](https://github.com/googleapis/release-please/compare/v16.14.3...v16.14.4) (2024-11-12)
 
 

package/README.md

@@ -195,6 +195,7 @@ Release Please automates releases for the following flavors of repositories:
 | `ocaml`             | [An OCaml repository, containing 1 or more opam or esy files and a CHANGELOG.md](https://github.com/grain-lang/binaryen.ml) |
 | `php`               | A repository with a composer.json and a CHANGELOG.md |
 | `python`            | [A Python repository, with a setup.py, setup.cfg, CHANGELOG.md](https://github.com/googleapis/python-storage) and optionally a pyproject.toml and a <project>/\_\_init\_\_.py |
+| `R`               | A repository with a DESCRIPTION and a NEWS.md |
 | `ruby`              | A repository with a version.rb and a CHANGELOG.md |
 | `rust`              | A Rust repository, with a Cargo.toml (either as a crate or workspace, although note that workspaces require a [manifest driven release](https://github.com/googleapis/release-please/blob/main/docs/manifest-releaser.md) and the "cargo-workspace" plugin) and a CHANGELOG.md |
 | `sfdx`              | A repository with a [sfdx-project.json](https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_ws_config.htm) and a CHANGELOG.md |

package/build/src/factory.js

@@ -49,6 +49,7 @@ const ocaml_1 = require("./strategies/ocaml");
 const php_1 = require("./strategies/php");
 const php_yoshi_1 = require("./strategies/php-yoshi");
 const python_1 = require("./strategies/python");
+const r_1 = require("./strategies/r");
 const ruby_1 = require("./strategies/ruby");
 const ruby_yoshi_1 = require("./strategies/ruby-yoshi");
 const rust_1 = require("./strategies/rust");
@@ -91,6 +92,7 @@ const releasers = {
     php: options => new php_1.PHP(options),
     'php-yoshi': options => new php_yoshi_1.PHPYoshi(options),
     python: options => new python_1.Python(options),
+    r: options => new r_1.R(options),
     ruby: options => new ruby_1.Ruby(options),
     'ruby-yoshi': options => new ruby_yoshi_1.RubyYoshi(options),
     rust: options => new rust_1.Rust(options),

package/build/src/index.d.ts

@@ -14,4 +14,4 @@ export { Logger, setLogger } from './util/logger';
 export { GitHub } from './github';
 export declare const configSchema: any;
 export declare const manifestSchema: any;
-export declare const VERSION = "16.14.4";
+export declare const VERSION = "16.16.0";

package/build/src/index.js

@@ -36,6 +36,6 @@ Object.defineProperty(exports, "GitHub", { enumerable: true, get: function () {
 exports.configSchema = require('../../schemas/config.json');
 exports.manifestSchema = require('../../schemas/manifest.json');
 // x-release-please-start-version
-exports.VERSION = '16.14.4';
+exports.VERSION = '16.16.0';
 // x-release-please-end
 //# sourceMappingURL=index.js.map

package/build/src/manifest.d.ts

@@ -140,6 +140,7 @@ export interface ManifestOptions {
     draft?: boolean;
     prerelease?: boolean;
     draftPullRequest?: boolean;
+    alwaysUpdate?: boolean;
     groupPullRequestTitlePattern?: string;
     releaseSearchDepth?: number;
     commitSearchDepth?: number;
@@ -188,6 +189,7 @@ export interface ManifestConfig extends ReleaserConfigJson {
     'release-search-depth'?: number;
     'commit-search-depth'?: number;
     'sequential-calls'?: boolean;
+    'always-update'?: boolean;
 }
 export type ReleasedVersions = Record<string, Version>;
 export type RepositoryConfig = Record<string, ReleaserConfig>;
@@ -215,6 +217,7 @@ export declare class Manifest {
     readonly releasedVersions: ReleasedVersions;
     private targetBranch;
     private separatePullRequests;
+    private alwaysUpdate;
     readonly fork: boolean;
     private signoffUser?;
     private labels;
@@ -253,6 +256,8 @@ export declare class Manifest {
      *   plugin
      * @param {boolean} manifestOptions.separatePullRequests If true, create separate pull
      *   requests instead of a single manifest release pull request
+     * @param {boolean} manifestOptions.alwaysUpdate If true, always updates pull requests instead of
+     *   only when the release notes change
      * @param {PluginType[]} manifestOptions.plugins Any plugins to use for this repository
      * @param {boolean} manifestOptions.fork If true, create pull requests from a fork. Defaults
      *   to `false`
@@ -325,6 +330,7 @@ export declare class Manifest {
     private createOrUpdatePullRequest;
     private maybeUpdateExistingPullRequest;
     private maybeUpdateSnoozedPullRequest;
+    private updateExistingPullRequest;
     private findMergedReleasePullRequests;
     /**
      * Find merged, untagged releases and build candidate releases to tag.

package/build/src/manifest.js

@@ -57,6 +57,8 @@ class Manifest {
      *   plugin
      * @param {boolean} manifestOptions.separatePullRequests If true, create separate pull
      *   requests instead of a single manifest release pull request
+     * @param {boolean} manifestOptions.alwaysUpdate If true, always updates pull requests instead of
+     *   only when the release notes change
      * @param {PluginType[]} manifestOptions.plugins Any plugins to use for this repository
      * @param {boolean} manifestOptions.fork If true, create pull requests from a fork. Defaults
      *   to `false`
@@ -78,6 +80,7 @@ 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.alwaysUpdate = (manifestOptions === null || manifestOptions === void 0 ? void 0 : manifestOptions.alwaysUpdate) || false;
         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 =
@@ -539,12 +542,16 @@ class Manifest {
         // look for existing, open pull request
         const existing = openPullRequests.find(openPullRequest => openPullRequest.headBranchName === pullRequest.headRefName);
         if (existing) {
-            return await this.maybeUpdateExistingPullRequest(existing, pullRequest);
+            return this.alwaysUpdate
+                ? await this.updateExistingPullRequest(existing, pullRequest)
+                : await this.maybeUpdateExistingPullRequest(existing, pullRequest);
         }
         // look for closed, snoozed pull request
         const snoozed = snoozedPullRequests.find(openPullRequest => openPullRequest.headBranchName === pullRequest.headRefName);
         if (snoozed) {
-            return await this.maybeUpdateSnoozedPullRequest(snoozed, pullRequest);
+            return this.alwaysUpdate
+                ? await this.updateExistingPullRequest(snoozed, pullRequest)
+                : await this.maybeUpdateSnoozedPullRequest(snoozed, pullRequest);
         }
         const body = await this.pullRequestOverflowHandler.handleOverflow(pullRequest);
         const message = this.signoffUser
@@ -571,28 +578,27 @@ class Manifest {
             this.logger.info(`PR https://github.com/${this.repository.owner}/${this.repository.repo}/pull/${existing.number} remained the same`);
             return undefined;
         }
-        const updatedPullRequest = await this.github.updatePullRequest(existing.number, pullRequest, this.targetBranch, {
-            fork: this.fork,
-            signoffUser: this.signoffUser,
-            pullRequestOverflowHandler: this.pullRequestOverflowHandler,
-        });
-        return updatedPullRequest;
+        return await this.updateExistingPullRequest(existing, pullRequest);
     }
-    /// only update an snoozed pull request if it has release note changes
+    /// only update a snoozed pull request if it has release note changes
     async maybeUpdateSnoozedPullRequest(snoozed, pullRequest) {
         // If unchanged, no need to push updates
         if (snoozed.body === pullRequest.body.toString()) {
             this.logger.info(`PR https://github.com/${this.repository.owner}/${this.repository.repo}/pull/${snoozed.number} remained the same`);
             return undefined;
         }
-        const updatedPullRequest = await this.github.updatePullRequest(snoozed.number, pullRequest, this.targetBranch, {
+        const updatedPullRequest = await this.updateExistingPullRequest(snoozed, pullRequest);
+        // TODO: consider leaving the snooze label
+        await this.github.removeIssueLabels([exports.SNOOZE_LABEL], snoozed.number);
+        return updatedPullRequest;
+    }
+    /// force an update to an existing pull request
+    async updateExistingPullRequest(existing, pullRequest) {
+        return await this.github.updatePullRequest(existing.number, pullRequest, this.targetBranch, {
             fork: this.fork,
             signoffUser: this.signoffUser,
             pullRequestOverflowHandler: this.pullRequestOverflowHandler,
         });
-        // TODO: consider leaving the snooze label
-        await this.github.removeIssueLabels([exports.SNOOZE_LABEL], snoozed.number);
-        return updatedPullRequest;
     }
     async *findMergedReleasePullRequests() {
         // Find merged release pull requests
@@ -865,6 +871,7 @@ async function parseConfig(github, configFile, branch, onlyPath, releaseAs) {
         lastReleaseSha: config['last-release-sha'],
         alwaysLinkLocal: config['always-link-local'],
         separatePullRequests: config['separate-pull-requests'],
+        alwaysUpdate: config['always-update'],
         groupPullRequestTitlePattern: config['group-pull-request-title-pattern'],
         plugins: config['plugins'],
         signoff: config['signoff'],

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

@@ -0,0 +1,8 @@
+import { BaseStrategy, BuildUpdatesOptions, BaseStrategyOptions } from './base';
+import { Update } from '../update';
+import { Version } from '../version';
+export declare class R extends BaseStrategy {
+    constructor(options: BaseStrategyOptions);
+    protected buildUpdates(options: BuildUpdatesOptions): Promise<Update[]>;
+    protected initialReleaseVersion(): Version;
+}

package/build/src/strategies/r.js

@@ -0,0 +1,67 @@
+"use strict";
+// Copyright 2025 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.R = void 0;
+const base_1 = require("./base");
+const news_1 = require("../updaters/r/news");
+const version_1 = require("../version");
+const description_1 = require("../updaters/r/description");
+const CHANGELOG_SECTIONS = [
+    { type: 'feat', section: 'Features' },
+    { type: 'fix', section: 'Bug Fixes' },
+    { type: 'perf', section: 'Performance Improvements' },
+    { type: 'deps', section: 'Dependencies' },
+    { type: 'revert', section: 'Reverts' },
+    { type: 'docs', section: 'Documentation' },
+    { type: 'style', section: 'Styles', hidden: true },
+    { type: 'chore', section: 'Miscellaneous Chores', hidden: true },
+    { type: 'refactor', section: 'Code Refactoring', hidden: true },
+    { type: 'test', section: 'Tests', hidden: true },
+    { type: 'build', section: 'Build System', hidden: true },
+    { type: 'ci', section: 'Continuous Integration', hidden: true },
+];
+class R extends base_1.BaseStrategy {
+    constructor(options) {
+        var _a, _b;
+        options.changelogPath = (_a = options.changelogPath) !== null && _a !== void 0 ? _a : 'NEWS.md';
+        options.changelogSections = (_b = options.changelogSections) !== null && _b !== void 0 ? _b : CHANGELOG_SECTIONS;
+        super(options);
+    }
+    async buildUpdates(options) {
+        const updates = [];
+        const version = options.newVersion;
+        updates.push({
+            path: this.addPath(this.changelogPath),
+            createIfMissing: true,
+            updater: new news_1.News({
+                version,
+                changelogEntry: options.changelogEntry,
+            }),
+        });
+        updates.push({
+            path: this.addPath('DESCRIPTION'),
+            createIfMissing: false,
+            updater: new description_1.DescriptionUpdater({
+                version,
+            }),
+        });
+        return updates;
+    }
+    initialReleaseVersion() {
+        return version_1.Version.parse('0.1.0');
+    }
+}
+exports.R = R;
+//# sourceMappingURL=r.js.map

package/build/src/updaters/changelog-json.d.ts

@@ -7,7 +7,7 @@ interface ChangelogJsonOptions extends UpdateOptions {
     commits: ConventionalCommit[];
 }
 /**
- * Maintians a machine readable CHANGELOG in chnagelog.json.
+ * Maintains a machine readable CHANGELOG in chnagelog.json.
  * See: https://gist.github.com/bcoe/50ef0a0024bbf107cd5bc0adbdc04758
  */
 export declare class ChangelogJson extends DefaultUpdater {

package/build/src/updaters/changelog-json.js

@@ -21,7 +21,7 @@ const BREAKING_CHANGE_TITLE = 'BREAKING CHANGE';
 const COMMIT_PREFIX = /^[^:]+: ?/;
 const PR_SUFFIX_REGEX = / ?\(#(?<pr>[0-9]+)\)$/;
 /**
- * Maintians a machine readable CHANGELOG in chnagelog.json.
+ * Maintains a machine readable CHANGELOG in chnagelog.json.
  * See: https://gist.github.com/bcoe/50ef0a0024bbf107cd5bc0adbdc04758
  */
 class ChangelogJson extends default_1.DefaultUpdater {

package/build/src/updaters/r/description.d.ts

@@ -0,0 +1,12 @@
+import { DefaultUpdater } from '../default';
+/**
+ * Updates the DESCRIPTION file of an R package.
+ */
+export declare class DescriptionUpdater extends DefaultUpdater {
+    /**
+     * Given initial file contents, return updated contents.
+     * @param {string} content The initial content
+     * @returns {string} The updated content
+     */
+    updateContent(content: string): string;
+}

package/build/src/updaters/r/description.js

@@ -0,0 +1,32 @@
+"use strict";
+// Copyright 2025 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DescriptionUpdater = void 0;
+const default_1 = require("../default");
+/**
+ * Updates the DESCRIPTION file of an R package.
+ */
+class DescriptionUpdater extends default_1.DefaultUpdater {
+    /**
+     * Given initial file contents, return updated contents.
+     * @param {string} content The initial content
+     * @returns {string} The updated content
+     */
+    updateContent(content) {
+        return content.replace(/^Version:\s*[0-9]+\.[0-9]+\.[0-9]+(?:\.[0-9]+)?\s*$/m, `Version: ${this.version}`);
+    }
+}
+exports.DescriptionUpdater = DescriptionUpdater;
+//# sourceMappingURL=description.js.map

package/build/src/updaters/r/news.d.ts

@@ -0,0 +1,12 @@
+import { DefaultUpdater, UpdateOptions } from '../default';
+interface ChangelogOptions extends UpdateOptions {
+    changelogEntry: string;
+    versionHeaderRegex?: string;
+}
+export declare class News extends DefaultUpdater {
+    changelogEntry: string;
+    readonly versionHeaderRegex: RegExp;
+    constructor(options: ChangelogOptions);
+    updateContent(content: string | undefined): string;
+}
+export {};

package/build/src/updaters/r/news.js

@@ -0,0 +1,49 @@
+"use strict";
+// Copyright 2025 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.News = void 0;
+const default_1 = require("../default");
+const DEFAULT_VERSION_HEADER_REGEX = '\n### v?[0-9[]';
+class News extends default_1.DefaultUpdater {
+    constructor(options) {
+        var _a;
+        super(options);
+        this.changelogEntry = options.changelogEntry;
+        this.versionHeaderRegex = new RegExp((_a = options.versionHeaderRegex) !== null && _a !== void 0 ? _a : DEFAULT_VERSION_HEADER_REGEX, 's');
+    }
+    updateContent(content) {
+        content = content || '';
+        const lastEntryIndex = content.search(this.versionHeaderRegex);
+        if (lastEntryIndex === -1) {
+            if (content) {
+                return `${this.changelogEntry}\n\n${adjustHeaders(content).trim()}\n`;
+            }
+            else {
+                return `${this.changelogEntry}\n`;
+            }
+        }
+        else {
+            const before = content.slice(0, lastEntryIndex);
+            const after = content.slice(lastEntryIndex);
+            return `${before}\n${this.changelogEntry}\n${after}`.trim() + '\n';
+        }
+    }
+}
+exports.News = News;
+// Helper to increase markdown H1 headers to H2
+function adjustHeaders(content) {
+    return content.replace(/^#(\s)/gm, '##$1');
+}
+//# sourceMappingURL=news.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "release-please",
-  "version": "16.14.4",
+  "version": "16.16.0",
   "description": "generate release PRs based on the conventionalcommits.org spec",
   "main": "./build/src/index.js",
   "bin": "./build/src/bin/release-please.js",
@@ -45,7 +45,7 @@
     "@types/inquirer": "^9.0.3",
     "@types/js-yaml": "^4.0.0",
     "@types/jsonpath": "^0.2.0",
-    "@types/mocha": "^9.0.0",
+    "@types/mocha": "^10.0.0",
     "@types/node": "^18.0.0",
     "@types/npmlog": "^7.0.0",
     "@types/pino": "^7.0.0",

package/schemas/config.json

@@ -111,6 +111,10 @@
           "description": "Open a separate release pull request for each component. Defaults to `false`.",
           "type": "boolean"
         },
+        "always-update": {
+          "description": "Always update the pull request with the latest changes. Defaults to `false`.",
+          "type": "boolean"
+        },
         "tag-separator": {
           "description": "Customize the separator between the component and version in the GitHub tag.",
           "type": "string"
@@ -470,6 +474,7 @@
     "pull-request-header": true,
     "pull-request-footer": true,
     "separate-pull-requests": true,
+    "always-update": true,
     "tag-separator": true,
     "extra-files": true,
     "version-file": true,