release-please 17.7.0 → 17.9.0

package/build/src/util/code-suggester/index.js

@@ -0,0 +1,110 @@
+"use strict";
+// Copyright 2026 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
+//
+//     https://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.createPullRequest = void 0;
+const logger_1 = require("./logger");
+const default_options_handler_1 = require("./default-options-handler");
+const retry = require("async-retry");
+const branch_1 = require("./github/branch");
+const fork_1 = require("./github/fork");
+const commit_and_push_1 = require("./github/commit-and-push");
+const open_pull_request_1 = require("./github/open-pull-request");
+const labels_1 = require("./github/labels");
+/**
+ * Make a new GitHub Pull Request with a set of changes applied on top of primary branch HEAD.
+ * The changes are committed into a new branch based on the upstream repository options using the authenticated Octokit account.
+ * Then a Pull Request is made from that branch.
+ *
+ * Also throws error if git data from the fork is not ready in 5 minutes.
+ *
+ * From the docs
+ * https://developer.github.com/v3/repos/forks/#create-a-fork
+ * """
+ * Forking a Repository happens asynchronously.
+ * You may have to wait a short period of time before you can access the git objects.
+ * If this takes longer than 5 minutes, be sure to contact GitHub Support or GitHub Premium Support.
+ * """
+ *
+ * If changes are empty then the workflow will not run.
+ * Rethrows an HttpError if Octokit GitHub API returns an error. HttpError Octokit access_token and client_secret headers redact all sensitive information.
+ * @param {Octokit} octokit The authenticated octokit instance, instantiated with an access token having permissiong to create a fork on the target repository
+ * @param {Changes | null | undefined} changes A set of changes. The changes may be empty
+ * @param {CreatePullRequestUserOptions} options The configuration for interacting with GitHub provided by the user.
+ * @returns {Promise<number>} the pull request number. Returns 0 if unsuccessful.
+ * @throws {CommitError} on failure during commit process
+ */
+async function createPullRequest(octokit, changes, options) {
+    (0, logger_1.setupLogger)(options.logger);
+    // if null undefined, or the empty map then no changes have been provided.
+    // Do not execute GitHub workflow
+    if (changes === null || changes === undefined || changes.size === 0) {
+        logger_1.logger.info('Empty change set provided. No changes need to be made. Cancelling workflow.');
+        return 0;
+    }
+    const gitHubConfigs = (0, default_options_handler_1.addPullRequestDefaults)(options);
+    logger_1.logger.info('Starting GitHub PR workflow...');
+    const upstream = {
+        owner: gitHubConfigs.upstreamOwner,
+        repo: gitHubConfigs.upstreamRepo,
+    };
+    const origin = options.fork === false ? upstream : await (0, fork_1.fork)(octokit, upstream);
+    if (options.fork) {
+        // try to sync the fork
+        await retry(async () => await octokit.repos.mergeUpstream({
+            owner: origin.owner,
+            repo: origin.repo,
+            branch: gitHubConfigs.primary,
+        }), {
+            retries: options.retry,
+            factor: 2.8411,
+            minTimeout: 3000,
+            randomize: false,
+            onRetry: (e, attempt) => {
+                e.message = `Error creating syncing upstream: ${e.message}`;
+                logger_1.logger.error(e);
+                logger_1.logger.info(`Retry attempt #${attempt}...`);
+            },
+        });
+    }
+    const originBranch = {
+        ...origin,
+        branch: gitHubConfigs.branch,
+    };
+    // The `retry` flag defaults to `5` to maintain compatibility
+    options.retry = options.retry === undefined ? 5 : options.retry;
+    const refHeadSha = await retry(async () => await (0, branch_1.branch)(octokit, origin, upstream, originBranch.branch, gitHubConfigs.primary), {
+        retries: options.retry,
+        factor: 2.8411,
+        minTimeout: 3000,
+        randomize: false,
+        onRetry: (e, attempt) => {
+            e.message = `Error creating Pull Request: ${e.message}`;
+            logger_1.logger.error(e);
+            logger_1.logger.info(`Retry attempt #${attempt}...`);
+        },
+    });
+    await (0, commit_and_push_1.commitAndPush)(octokit, refHeadSha, changes, originBranch, gitHubConfigs.message, gitHubConfigs.force, options);
+    const description = {
+        body: gitHubConfigs.description,
+        title: gitHubConfigs.title,
+    };
+    const prNumber = await (0, open_pull_request_1.openPullRequest)(octokit, upstream, originBranch, description, gitHubConfigs.maintainersCanModify, gitHubConfigs.primary, options.draft);
+    logger_1.logger.info(`Successfully opened pull request: ${prNumber}.`);
+    // addLabels will no-op if options.labels is undefined or empty.
+    await (0, labels_1.addLabels)(octokit, upstream, originBranch, prNumber, options.labels);
+    return prNumber;
+}
+exports.createPullRequest = createPullRequest;
+//# sourceMappingURL=index.js.map

package/build/src/util/code-suggester/logger.d.ts

@@ -0,0 +1,4 @@
+import { Logger } from './types';
+declare let logger: Logger;
+declare function setupLogger(userLogger?: Logger): void;
+export { logger, setupLogger };

package/build/src/util/code-suggester/logger.js

@@ -0,0 +1,37 @@
+"use strict";
+// Copyright 2026 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
+//
+//     https://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.setupLogger = exports.logger = void 0;
+class NullLogger {
+    constructor() {
+        this.error = () => { };
+        this.warn = () => { };
+        this.info = () => { };
+        this.debug = () => { };
+        this.trace = () => { };
+    }
+}
+let logger = new NullLogger();
+exports.logger = logger;
+function setupLogger(userLogger) {
+    if (userLogger) {
+        exports.logger = logger = userLogger;
+    }
+    else {
+        exports.logger = logger = new NullLogger();
+    }
+}
+exports.setupLogger = setupLogger;
+//# sourceMappingURL=logger.js.map

package/build/src/util/code-suggester/types.d.ts

@@ -0,0 +1,109 @@
+import { CreateCommitOptions } from './github/create-commit';
+export type FileMode = '100644' | '100755' | '040000' | '160000' | '120000';
+/**
+ * GitHub definition of tree
+ */
+export interface TreeObject {
+    path: string;
+    mode: FileMode;
+    type: 'blob' | 'tree' | 'commit';
+    sha?: string | null;
+    content?: string;
+}
+/**
+ * The content and the mode of a file.
+ * Default file mode is a text file which has code '100644'.
+ * If `content` is not null, then `content` must be the entire file content.
+ * See https://developer.github.com/v3/git/trees/#tree-object for details on mode.
+ */
+export declare class FileData {
+    readonly mode: FileMode;
+    readonly content: string | null;
+    constructor(content: string | null, mode?: FileMode);
+}
+/**
+ * The map of a path to its content data.
+ * The content must be the entire file content.
+ */
+export type Changes = Map<string, FileData>;
+/**
+ * The domain of a repository
+ */
+export interface RepoDomain {
+    repo: string;
+    owner: string;
+}
+/**
+ * The domain for a branch
+ */
+export interface BranchDomain extends RepoDomain {
+    branch: string;
+}
+/**
+ * The descriptive properties for any entity
+ */
+export interface Description {
+    title: string;
+    body: string;
+}
+/**
+ * The user options for creating GitHub PRs
+ */
+export interface CreatePullRequestUserOptions extends CreateCommitOptions {
+    upstreamOwner: string;
+    upstreamRepo: string;
+    message: string;
+    description: string;
+    title: string;
+    branch?: string;
+    force?: boolean;
+    fork?: boolean;
+    primary?: string;
+    maintainersCanModify?: boolean;
+    labels?: string[];
+    retry?: number;
+    draft?: boolean;
+    logger?: Logger;
+    filesPerCommit?: number;
+}
+/**
+ * GitHub data needed for creating a PR
+ */
+export interface CreatePullRequest {
+    upstreamOwner: string;
+    upstreamRepo: string;
+    message: string;
+    description: string;
+    title: string;
+    branch: string;
+    force: boolean;
+    primary: string;
+    maintainersCanModify: boolean;
+    filesPerCommit?: number;
+}
+interface LogFn {
+    <T extends object>(obj: T, msg?: string, ...args: any[]): void;
+    (msg: string, ...args: any[]): void;
+}
+export interface Logger {
+    error: LogFn;
+    warn: LogFn;
+    info: LogFn;
+    debug: LogFn;
+    trace: LogFn;
+}
+export interface UserData {
+    name: string;
+    email: string;
+}
+export interface CommitData {
+    message: string;
+    tree: string;
+    parents: string[];
+    author?: UserData;
+    committer?: UserData;
+}
+export interface CommitSigner {
+    generateSignature(commit: CommitData): Promise<string>;
+}
+export {};

package/build/src/util/code-suggester/types.js

@@ -0,0 +1,30 @@
+"use strict";
+// Copyright 2026 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
+//
+//     https://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.FileData = void 0;
+/**
+ * The content and the mode of a file.
+ * Default file mode is a text file which has code '100644'.
+ * If `content` is not null, then `content` must be the entire file content.
+ * See https://developer.github.com/v3/git/trees/#tree-object for details on mode.
+ */
+class FileData {
+    constructor(content, mode = '100644') {
+        this.mode = mode;
+        this.content = content;
+    }
+}
+exports.FileData = FileData;
+//# sourceMappingURL=types.js.map

package/build/src/util/pull-request-title.js

@@ -32,10 +32,10 @@ function generateMatchPattern(pullRequestTitlePattern, componentNoSpace, logger
         pullRequestTitlePattern.search(/\$\{version\}/) === -1)
         logger.warn("pullRequestTitlePattern miss the part of '${version}'");
     return new RegExp(`^${(pullRequestTitlePattern || DEFAULT_PR_TITLE_PATTERN)
-        .replace('[', '\\[') // TODO: handle all regex escaping
-        .replace(']', '\\]')
-        .replace('(', '\\(')
-        .replace(')', '\\)')
+        .replace(/\[/g, '\\[') // TODO: handle all regex escaping
+        .replace(/\]/g, '\\]')
+        .replace(/\(/g, '\\(')
+        .replace(/\)/g, '\\)')
         .replace('${scope}', '(\\((?<branch>[\\w-./]+)\\))?')
         .replace('${component}', componentNoSpace === true
         ? '?(?<component>@?[\\w-./]*)?'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "release-please",
-  "version": "17.7.0",
+  "version": "17.9.0",
   "description": "generate release PRs based on the conventionalcommits.org spec",
   "main": "./build/src/index.js",
   "bin": "./build/src/bin/release-please.js",
@@ -39,6 +39,7 @@
   },
   "devDependencies": {
     "@octokit/types": "^9.0.0",
+    "@types/async-retry": "^1.4.9",
     "@types/chai": "^4.1.7",
     "@types/diff": "^5.0.2",
     "@types/iarna__toml": "^2.0.1",
@@ -75,8 +76,8 @@
     "@octokit/rest": "^20.1.1",
     "@types/npm-package-arg": "^6.1.0",
     "@xmldom/xmldom": "^0.8.4",
+    "async-retry": "^1.3.3",
     "chalk": "^4.0.0",
-    "code-suggester": "^5.0.0",
     "conventional-changelog-conventionalcommits": "^6.0.0",
     "conventional-changelog-writer": "^6.0.0",
     "conventional-commits-filter": "^3.0.0",

package/build/src/updaters/java/librarian-yaml.d.ts

@@ -1,29 +0,0 @@
-import { DefaultUpdater } from '../default';
-import { Logger } from '../../util/logger';
-export interface JavaModule {
-    artifact_id: string;
-    [key: string]: any;
-}
-export interface LibrarianLibrary {
-    name: string;
-    version: string;
-    java: JavaModule;
-    [key: string]: any;
-}
-export interface LibrarianYamlSchema {
-    libraries: LibrarianLibrary[];
-    [key: string]: any;
-}
-/**
- * Updates a librarian.yaml file.
- */
-export declare class LibrarianYamlUpdater extends DefaultUpdater {
-    specialArtifacts: ReadonlyMap<string, string>;
-    /**
-     * Given initial file contents, return updated contents.
-     * @param {string} content The initial content
-     * @returns {string} The updated content
-     */
-    updateContent(content: string, logger?: Logger): string;
-    findArtifactID(library: LibrarianLibrary): string;
-}

package/build/src/updaters/java/librarian-yaml.js

@@ -1,81 +0,0 @@
-"use strict";
-// Copyright 2026 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.LibrarianYamlUpdater = void 0;
-const default_1 = require("../default");
-const yaml = require("yaml");
-const logger_1 = require("../../util/logger");
-/**
- * Updates a librarian.yaml file.
- */
-class LibrarianYamlUpdater extends default_1.DefaultUpdater {
-    constructor() {
-        super(...arguments);
-        this.specialArtifacts = new Map([
-            ['google-cloud-java', 'google-cloud-java'],
-        ]);
-    }
-    /**
-     * Given initial file contents, return updated contents.
-     * @param {string} content The initial content
-     * @returns {string} The updated content
-     */
-    updateContent(content, logger = logger_1.logger) {
-        if (!this.versionsMap) {
-            logger.warn('missing versions map');
-            return content;
-        }
-        // Use yaml package to make sure librarian.yaml is not reformatted because
-        // we use different tool to format librarian.yaml.
-        const doc = yaml.parseDocument(content);
-        if (!doc || doc.errors.length > 0) {
-            logger.warn('Invalid yaml, cannot be parsed');
-            return content;
-        }
-        const libraries = doc.get('libraries');
-        if (!libraries || !yaml.isSeq(libraries)) {
-            return content;
-        }
-        let modified = false;
-        for (const library of libraries.items) {
-            if (!yaml.isMap(library))
-                continue;
-            const artifactID = this.findArtifactID(library.toJSON());
-            if (this.versionsMap.has(artifactID)) {
-                const newVersion = this.versionsMap.get(artifactID);
-                if (newVersion && library.get('version') !== newVersion.toString()) {
-                    library.set('version', newVersion.toString());
-                    modified = true;
-                }
-            }
-        }
-        if (modified) {
-            return doc.toString({ lineWidth: 0 });
-        }
-        return content;
-    }
-    findArtifactID(library) {
-        const artifact = this.specialArtifacts.get(library.name);
-        if (artifact) {
-            return artifact;
-        }
-        if (library.java && library.java.artifact_id) {
-            return library.java.artifact_id;
-        }
-        return `google-cloud-${library.name}`;
-    }
-}
-exports.LibrarianYamlUpdater = LibrarianYamlUpdater;
-//# sourceMappingURL=librarian-yaml.js.map

package/build/src/updaters/node/librarian-yaml.js

@@ -1,73 +0,0 @@
-"use strict";
-// Copyright 2026 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.LibrarianYamlUpdater = void 0;
-const default_1 = require("../default");
-const yaml = require("yaml");
-const logger_1 = require("../../util/logger");
-/**
- * Updates a librarian.yaml file.
- */
-class LibrarianYamlUpdater extends default_1.DefaultUpdater {
-    constructor(options) {
-        super(options);
-        this.packagePath = options.packagePath;
-    }
-    /**
-     * Given initial file contents, return updated contents.
-     * @param {string} content The initial content
-     * @returns {string} The updated content
-     */
-    updateContent(content, logger = logger_1.logger) {
-        // Use yaml package to make sure librarian.yaml is not reformatted because
-        // we use different tool to format librarian.yaml.
-        const doc = yaml.parseDocument(content);
-        if (!doc || doc.errors.length > 0) {
-            logger.warn('Invalid yaml, cannot be parsed');
-            return content;
-        }
-        const libraries = doc.get('libraries');
-        if (!libraries || !yaml.isSeq(libraries)) {
-            return content;
-        }
-        let modified = false;
-        for (const library of libraries.items) {
-            if (!yaml.isMap(library))
-                continue;
-            // The release-please version map key is the output directory (explicit or
-            // derived) in librarian.yaml.
-            const outputDirectory = this.deriveOutputDirectory(library.toJSON());
-            if (outputDirectory === this.packagePath) {
-                const newVersion = this.version.toString();
-                if (library.get('version') !== newVersion) {
-                    library.set('version', newVersion);
-                    modified = true;
-                }
-            }
-        }
-        if (modified) {
-            return doc.toString({ lineWidth: 0 });
-        }
-        return content;
-    }
-    deriveOutputDirectory(library) {
-        if (library.output) {
-            return library.output;
-        }
-        return `packages/${library.name}`;
-    }
-}
-exports.LibrarianYamlUpdater = LibrarianYamlUpdater;
-//# sourceMappingURL=librarian-yaml.js.map