release-please 16.16.0 → 16.18.0

package/CHANGELOG.md

@@ -4,6 +4,20 @@
 
 [1]: https://www.npmjs.com/package/release-please?activeTab=versions
 
+## [16.18.0](https://github.com/googleapis/release-please/compare/v16.17.0...v16.18.0) (2025-02-27)
+
+
+### Features
+
+* Manifest.createRelease to return PR numbers ([#2491](https://github.com/googleapis/release-please/issues/2491)) ([0f07691](https://github.com/googleapis/release-please/commit/0f076910c719b8dc8563936039b0708567811049))
+
+## [16.17.0](https://github.com/googleapis/release-please/compare/v16.16.0...v16.17.0) (2025-02-20)
+
+
+### Features
+
+* allow date updating in generic strategy ([#2440](https://github.com/googleapis/release-please/issues/2440)) ([3099091](https://github.com/googleapis/release-please/commit/3099091bb6787e49fe36e289db36ac01a71af2c3))
+
 ## [16.16.0](https://github.com/googleapis/release-please/compare/v16.15.0...v16.16.0) (2025-02-19)
 
 

package/README.md

@@ -194,7 +194,7 @@ Release Please automates releases for the following flavors of repositories:
 | `expo`              | [An Expo based React Native repository, with a package.json, app.json and CHANGELOG.md](https://github.com/dmi3y/expo-release-please-example) |
 | `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 |
+| `python`            | [A Python repository with a pyproject.toml, <project>/\_\_init\_\_.py, CHANGELOG.md or optionally a setup.py, setup.cfg](https://github.com/googleapis/python-storage) |
 | `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 |

package/build/src/bin/release-please.js

@@ -210,6 +210,10 @@ function pullRequestStrategyOptions(yargs) {
         .option('latest-tag-name', {
         describe: 'Override the detected latest tag name',
         type: 'string',
+    })
+        .option('date-format', {
+        describe: 'format in strftime format for updating dates',
+        type: 'string',
     })
         .middleware(_argv => {
         const argv = _argv;

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.16.0";
+export declare const VERSION = "16.18.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.16.0';
+exports.VERSION = '16.18.0';
 // x-release-please-end
 //# sourceMappingURL=index.js.map

package/build/src/manifest.d.ts

@@ -70,6 +70,7 @@ export interface ReleaserConfig {
     releaseLabels?: string[];
     extraLabels?: string[];
     initialVersion?: string;
+    dateFormat?: string;
     changelogSections?: ChangelogSection[];
     changelogPath?: string;
     changelogType?: ChangelogNotesType;
@@ -122,6 +123,7 @@ interface ReleaserConfigJson {
     'skip-snapshot'?: boolean;
     'initial-version'?: string;
     'exclude-paths'?: string[];
+    'date-format'?: string;
 }
 export interface ManifestOptions {
     bootstrapSha?: string;
@@ -145,6 +147,7 @@ export interface ManifestOptions {
     releaseSearchDepth?: number;
     commitSearchDepth?: number;
     logger?: Logger;
+    dateFormat?: string;
 }
 export interface ReleaserPackageConfig extends ReleaserConfigJson {
     'package-name'?: string;
@@ -209,6 +212,7 @@ export interface CreatedRelease extends GitHubRelease {
     major: number;
     minor: number;
     patch: number;
+    prNumber: number;
 }
 export declare class Manifest {
     private repository;

package/build/src/manifest.js

@@ -704,7 +704,7 @@ class Manifest {
             if (error)
                 continue;
             try {
-                githubReleases.push(await this.createRelease(release));
+                githubReleases.push(await this.createRelease(release, pullRequest));
             }
             catch (err) {
                 if (err instanceof errors_1.DuplicateReleaseError) {
@@ -747,7 +747,7 @@ class Manifest {
         }
         return githubReleases;
     }
-    async createRelease(release) {
+    async createRelease(release, pullRequest) {
         const githubRelease = await this.github.createRelease(release, {
             draft: release.draft,
             prerelease: release.prerelease,
@@ -759,6 +759,7 @@ class Manifest {
             major: release.tag.version.major,
             minor: release.tag.version.minor,
             patch: release.tag.version.patch,
+            prNumber: pullRequest.number,
         };
     }
     async getStrategiesByPath() {
@@ -838,6 +839,7 @@ function extractReleaserConfig(config) {
         skipSnapshot: config['skip-snapshot'],
         initialVersion: config['initial-version'],
         excludePaths: config['exclude-paths'],
+        dateFormat: config['date-format'],
     };
 }
 /**
@@ -1051,7 +1053,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, _x, _y, _z, _0, _1, _2, _3, _4, _5, _6;
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u, _v, _w, _x, _y, _z, _0, _1, _2, _3, _4, _5, _6, _7;
     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,
@@ -1083,6 +1085,7 @@ function mergeReleaserConfig(defaultConfig, pathConfig) {
         initialVersion: (_4 = pathConfig.initialVersion) !== null && _4 !== void 0 ? _4 : defaultConfig.initialVersion,
         extraLabels: (_5 = pathConfig.extraLabels) !== null && _5 !== void 0 ? _5 : defaultConfig.extraLabels,
         excludePaths: (_6 = pathConfig.excludePaths) !== null && _6 !== void 0 ? _6 : defaultConfig.excludePaths,
+        dateFormat: (_7 = pathConfig.dateFormat) !== null && _7 !== void 0 ? _7 : defaultConfig.dateFormat,
     };
 }
 /**

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

@@ -52,6 +52,7 @@ export interface BaseStrategyOptions {
     logger?: Logger;
     initialVersion?: string;
     extraLabels?: string[];
+    dateFormat?: string;
 }
 /**
  * A strategy is responsible for determining which files are
@@ -80,6 +81,7 @@ export declare abstract class BaseStrategy implements Strategy {
     readonly componentNoSpace?: boolean;
     readonly extraFiles: ExtraFile[];
     readonly extraLabels: string[];
+    protected dateFormat: string;
     readonly changelogNotes: ChangelogNotes;
     protected changelogSections?: ChangelogSection[];
     constructor(options: BaseStrategyOptions);
@@ -119,7 +121,7 @@ export declare abstract class BaseStrategy implements Strategy {
      */
     buildReleasePullRequest(commits: ConventionalCommit[], latestRelease?: Release, draft?: boolean, labels?: string[], bumpOnlyOptions?: BumpReleaseOptions): Promise<ReleasePullRequest | undefined>;
     private extraFilePaths;
-    protected extraFileUpdates(version: Version, versionsMap: VersionsMap): Promise<Update[]>;
+    protected extraFileUpdates(version: Version, versionsMap: VersionsMap, dateFormat: string): Promise<Update[]>;
     protected changelogEmpty(changelogEntry: string): boolean;
     protected updateVersionsMap(versionsMap: VersionsMap, conventionalCommits: ConventionalCommit[], _newVersion: Version): Promise<VersionsMap>;
     protected buildNewVersion(conventionalCommits: ConventionalCommit[], latestRelease?: Release): Promise<Version>;

package/build/src/strategies/base.js

@@ -66,6 +66,7 @@ class BaseStrategy {
         this.extraFiles = options.extraFiles || [];
         this.initialVersion = options.initialVersion;
         this.extraLabels = options.extraLabels || [];
+        this.dateFormat = options.dateFormat || generic_1.DEFAULT_DATE_FORMAT;
     }
     /**
      * Return the component for this strategy. This may be a computed field.
@@ -175,7 +176,7 @@ class BaseStrategy {
             latestVersion: latestRelease === null || latestRelease === void 0 ? void 0 : latestRelease.tag.version,
             commits: conventionalCommits,
         });
-        const updatesWithExtras = (0, composite_1.mergeUpdates)(updates.concat(...(await this.extraFileUpdates(newVersion, versionsMap))));
+        const updatesWithExtras = (0, composite_1.mergeUpdates)(updates.concat(...(await this.extraFileUpdates(newVersion, versionsMap, this.dateFormat))));
         const pullRequestBody = await this.buildPullRequestBody(component, newVersion, releaseNotesBody, conventionalCommits, latestRelease, this.pullRequestHeader, this.pullRequestFooter);
         return {
             title: pullRequestTitle,
@@ -209,7 +210,7 @@ class BaseStrategy {
             return this.github.findFilesByGlobAndRef(extraFile.path, this.targetBranch, this.path);
         }
     }
-    async extraFileUpdates(version, versionsMap) {
+    async extraFileUpdates(version, versionsMap, dateFormat) {
         const extraFileUpdates = [];
         for (const extraFile of this.extraFiles) {
             if (typeof extraFile === 'object') {
@@ -220,7 +221,11 @@ class BaseStrategy {
                             extraFileUpdates.push({
                                 path: this.addPath(path),
                                 createIfMissing: false,
-                                updater: new generic_1.Generic({ version, versionsMap }),
+                                updater: new generic_1.Generic({
+                                    version,
+                                    versionsMap,
+                                    dateFormat: dateFormat,
+                                }),
                             });
                             break;
                         case 'json':
@@ -267,21 +272,21 @@ class BaseStrategy {
                 extraFileUpdates.push({
                     path: this.addPath(extraFile),
                     createIfMissing: false,
-                    updater: new composite_1.CompositeUpdater(new generic_json_1.GenericJson('$.version', version), new generic_1.Generic({ version, versionsMap })),
+                    updater: new composite_1.CompositeUpdater(new generic_json_1.GenericJson('$.version', version), new generic_1.Generic({ version, versionsMap, dateFormat: dateFormat })),
                 });
             }
             else if (extraFile.endsWith('.yaml') || extraFile.endsWith('.yml')) {
                 extraFileUpdates.push({
                     path: this.addPath(extraFile),
                     createIfMissing: false,
-                    updater: new composite_1.CompositeUpdater(new generic_yaml_1.GenericYaml('$.version', version), new generic_1.Generic({ version, versionsMap })),
+                    updater: new composite_1.CompositeUpdater(new generic_yaml_1.GenericYaml('$.version', version), new generic_1.Generic({ version, versionsMap, dateFormat: dateFormat })),
                 });
             }
             else if (extraFile.endsWith('.toml')) {
                 extraFileUpdates.push({
                     path: this.addPath(extraFile),
                     createIfMissing: false,
-                    updater: new composite_1.CompositeUpdater(new generic_toml_1.GenericToml('$.version', version), new generic_1.Generic({ version, versionsMap })),
+                    updater: new composite_1.CompositeUpdater(new generic_toml_1.GenericToml('$.version', version), new generic_1.Generic({ version, versionsMap, dateFormat: dateFormat })),
                 });
             }
             else if (extraFile.endsWith('.xml')) {
@@ -290,14 +295,14 @@ class BaseStrategy {
                     createIfMissing: false,
                     updater: new composite_1.CompositeUpdater(
                     // Updates "version" element that is a child of the root element.
-                    new generic_xml_1.GenericXml('/*/version', version), new generic_1.Generic({ version, versionsMap })),
+                    new generic_xml_1.GenericXml('/*/version', version), new generic_1.Generic({ version, versionsMap, dateFormat: dateFormat })),
                 });
             }
             else {
                 extraFileUpdates.push({
                     path: this.addPath(extraFile),
                     createIfMissing: false,
-                    updater: new generic_1.Generic({ version, versionsMap }),
+                    updater: new generic_1.Generic({ version, versionsMap, dateFormat: dateFormat }),
                 });
             }
         }

package/build/src/strategies/java.js

@@ -95,7 +95,7 @@ class Java extends base_1.BaseStrategy {
             isSnapshot: true,
             commits: [],
         });
-        const updatesWithExtras = (0, composite_1.mergeUpdates)(updates.concat(...(await this.extraFileUpdates(newVersion, versionsMap))));
+        const updatesWithExtras = (0, composite_1.mergeUpdates)(updates.concat(...(await this.extraFileUpdates(newVersion, versionsMap, this.dateFormat))));
         return {
             title: pullRequestTitle,
             body: pullRequestBody,

package/build/src/updaters/generic.d.ts

@@ -1,5 +1,6 @@
 import { DefaultUpdater, UpdateOptions } from './default';
 import { Logger } from '../util/logger';
+export declare const DEFAULT_DATE_FORMAT = "%Y-%m-%d";
 /**
  * Options for the Generic updater.
  */
@@ -7,6 +8,8 @@ export interface GenericUpdateOptions extends UpdateOptions {
     inlineUpdateRegex?: RegExp;
     blockStartRegex?: RegExp;
     blockEndRegex?: RegExp;
+    date?: Date;
+    dateFormat?: string;
 }
 /**
  * The Generic updater looks for well known patterns and replaces
@@ -24,17 +27,23 @@ export interface GenericUpdateOptions extends UpdateOptions {
  * 4. `x-release-please-patch` if this string is found on the line,
  *    then replace an integer looking value with the next version's
  *    patch
+ * 5. `x-release-please-date` if this string is found on the line,
+ *    then replace the date with the date of the last commit
+ * 6. `x-release-please-version-date` if this string is found on the line,
+ *    then replace the both date and version
  *
  * You can also use a block-based replacement. Content between the
  * opening `x-release-please-start-version` and `x-release-please-end` will
  * be considered for version replacement. You can also open these blocks
- * with `x-release-please-start-<major|minor|patch>` to replace single
- * numbers
+ * with `x-release-please-start-<major|minor|patch|version-date>` to replace
+ * single numbers
  */
 export declare class Generic extends DefaultUpdater {
     private readonly inlineUpdateRegex;
     private readonly blockStartRegex;
     private readonly blockEndRegex;
+    private readonly date;
+    private readonly dateFormat;
     constructor(options: GenericUpdateOptions);
     /**
      * Given initial file contents, return updated contents.

package/build/src/updaters/generic.js

@@ -13,14 +13,16 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Generic = void 0;
+exports.Generic = exports.DEFAULT_DATE_FORMAT = void 0;
 const default_1 = require("./default");
 const logger_1 = require("../util/logger");
 const VERSION_REGEX = /(?<major>\d+)\.(?<minor>\d+)\.(?<patch>\d+)(-(?<preRelease>[\w.]+))?(\+(?<build>[-\w.]+))?/;
 const SINGLE_VERSION_REGEX = /\b\d+\b/;
-const INLINE_UPDATE_REGEX = /x-release-please-(?<scope>major|minor|patch|version)/;
-const BLOCK_START_REGEX = /x-release-please-start-(?<scope>major|minor|patch|version)/;
+const INLINE_UPDATE_REGEX = /x-release-please-(?<scope>major|minor|patch|version-date|version|date)/;
+const BLOCK_START_REGEX = /x-release-please-start-(?<scope>major|minor|patch|version-date|version|date)/;
 const BLOCK_END_REGEX = /x-release-please-end/;
+const DATE_FORMAT_REGEX = /%[Ymd]/g;
+exports.DEFAULT_DATE_FORMAT = '%Y-%m-%d';
 /**
  * The Generic updater looks for well known patterns and replaces
  * content. The well known patterns are:
@@ -37,20 +39,26 @@ const BLOCK_END_REGEX = /x-release-please-end/;
  * 4. `x-release-please-patch` if this string is found on the line,
  *    then replace an integer looking value with the next version's
  *    patch
+ * 5. `x-release-please-date` if this string is found on the line,
+ *    then replace the date with the date of the last commit
+ * 6. `x-release-please-version-date` if this string is found on the line,
+ *    then replace the both date and version
  *
  * You can also use a block-based replacement. Content between the
  * opening `x-release-please-start-version` and `x-release-please-end` will
  * be considered for version replacement. You can also open these blocks
- * with `x-release-please-start-<major|minor|patch>` to replace single
- * numbers
+ * with `x-release-please-start-<major|minor|patch|version-date>` to replace
+ * single numbers
  */
 class Generic extends default_1.DefaultUpdater {
     constructor(options) {
-        var _a, _b, _c;
+        var _a, _b, _c, _d, _e;
         super(options);
         this.inlineUpdateRegex = (_a = options.inlineUpdateRegex) !== null && _a !== void 0 ? _a : INLINE_UPDATE_REGEX;
         this.blockStartRegex = (_b = options.blockStartRegex) !== null && _b !== void 0 ? _b : BLOCK_START_REGEX;
         this.blockEndRegex = (_c = options.blockEndRegex) !== null && _c !== void 0 ? _c : BLOCK_END_REGEX;
+        this.date = (_d = options.date) !== null && _d !== void 0 ? _d : new Date();
+        this.dateFormat = (_e = options.dateFormat) !== null && _e !== void 0 ? _e : exports.DEFAULT_DATE_FORMAT;
     }
     /**
      * Given initial file contents, return updated contents.
@@ -63,8 +71,28 @@ class Generic extends default_1.DefaultUpdater {
         }
         const newLines = [];
         let blockScope;
-        function replaceVersion(line, scope, version) {
+        function replaceVersion(line, scope, version, date, dateFormat) {
+            const dateRegex = createDateRegex(dateFormat);
+            const formattedDate = formatDate(dateFormat, date);
             switch (scope) {
+                case 'date':
+                    if (isValidDate(formattedDate, dateFormat)) {
+                        newLines.push(line.replace(dateRegex, formattedDate));
+                    }
+                    else {
+                        logger.warn(`Invalid date format: ${formattedDate}`);
+                        newLines.push(line);
+                    }
+                    return;
+                case 'version-date':
+                    if (isValidDate(formattedDate, dateFormat)) {
+                        line = line.replace(dateRegex, formattedDate);
+                    }
+                    else {
+                        logger.warn(`Invalid date format: ${formattedDate}`);
+                    }
+                    newLines.push(line.replace(VERSION_REGEX, version.toString()));
+                    return;
                 case 'major':
                     newLines.push(line.replace(SINGLE_VERSION_REGEX, `${version.major}`));
                     return;
@@ -87,11 +115,11 @@ class Generic extends default_1.DefaultUpdater {
             let match = line.match(this.inlineUpdateRegex);
             if (match) {
                 // replace inline versions
-                replaceVersion(line, (((_a = match.groups) === null || _a === void 0 ? void 0 : _a.scope) || 'version'), this.version);
+                replaceVersion(line, (((_a = match.groups) === null || _a === void 0 ? void 0 : _a.scope) || 'version'), this.version, this.date, this.dateFormat);
             }
             else if (blockScope) {
                 // in a block, so try to replace versions
-                replaceVersion(line, blockScope, this.version);
+                replaceVersion(line, blockScope, this.version, this.date, this.dateFormat);
                 if (line.match(this.blockEndRegex)) {
                     blockScope = undefined;
                 }
@@ -114,4 +142,45 @@ class Generic extends default_1.DefaultUpdater {
     }
 }
 exports.Generic = Generic;
+function createDateRegex(format) {
+    const regexString = format.replace(DATE_FORMAT_REGEX, match => {
+        switch (match) {
+            case '%Y':
+                return '(\\d{4})';
+            case '%m':
+                return '(\\d{2})';
+            case '%d':
+                return '(\\d{2})';
+            default:
+                return match;
+        }
+    });
+    return new RegExp(regexString);
+}
+function formatDate(format, date) {
+    return format.replace(DATE_FORMAT_REGEX, match => {
+        switch (match) {
+            case '%Y':
+                return date.getFullYear().toString();
+            case '%m':
+                return ('0' + (date.getMonth() + 1)).slice(-2);
+            case '%d':
+                return ('0' + date.getDate()).slice(-2);
+            default:
+                return match;
+        }
+    });
+}
+function isValidDate(dateString, format) {
+    const dateParts = dateString.match(/\d+/g);
+    if (!dateParts)
+        return false;
+    const year = parseInt(dateParts[format.indexOf('%Y') / 3], 10);
+    const month = parseInt(dateParts[format.indexOf('%m') / 3], 10);
+    const day = parseInt(dateParts[format.indexOf('%d') / 3], 10);
+    if (year < 1 || month < 1 || month > 12 || day < 1 || day > 31)
+        return false;
+    const daysInMonth = new Date(year, month, 0).getDate();
+    return day <= daysInMonth;
+}
 //# sourceMappingURL=generic.js.map

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

@@ -70,7 +70,8 @@ function releaserConfigToJsonConfig(config) {
         '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
+        'snapshot-label': (_c = config.snapshotLabels) === null || _c === void 0 ? void 0 : _c.join(','),
+        'date-format': config.dateFormat,
     };
     return jsonConfig;
 }

package/package.json

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

@@ -119,6 +119,10 @@
           "description": "Customize the separator between the component and version in the GitHub tag.",
           "type": "string"
         },
+        "date-format": {
+          "description": "Date format given as a strftime expression for the generic strategy.",
+          "type": "string"
+        },
         "extra-files": {
           "description": "Specify extra generic files to replace versions.",
           "type": "array",
@@ -476,6 +480,7 @@
     "separate-pull-requests": true,
     "always-update": true,
     "tag-separator": true,
+    "date-format": true,
     "extra-files": true,
     "version-file": true,
     "snapshot-label": true,