release-please 13.8.1 → 13.9.0

package/CHANGELOG.md

@@ -4,6 +4,13 @@
 
 [1]: https://www.npmjs.com/package/release-please?activeTab=versions
 
+## [13.9.0](https://github.com/googleapis/release-please/compare/v13.8.1...v13.9.0) (2022-04-12)
+
+
+### Features
+
+* added java strategy ([#1333](https://github.com/googleapis/release-please/issues/1333)) ([25f9c85](https://github.com/googleapis/release-please/commit/25f9c85a8472208a83dfd5cc4014c84adc3c771f))
+
 ### [13.8.1](https://github.com/googleapis/release-please/compare/v13.8.0...v13.8.1) (2022-04-11)
 
 

package/README.md

@@ -32,9 +32,10 @@ When the Release PR is merged, release-please takes the following steps:
 You can tell where the Release PR is its lifecycle by the status label on the
 PR itself:
 
-- `autorelease:pending` is the initial state of the Release PR before it is merged
-- `autorelease:tagged` means that the Release PR has been merged and the release has been tagged in GitHub
-- `autorelease:published` means that a GitHub release has been published based on the Release PR (_release-please does not automatically add this tag, but we recommend it as a convention for publication tooling_).
+- `autorelease: pending` is the initial state of the Release PR before it is merged
+- `autorelease: tagged` means that the Release PR has been merged and the release has been tagged in GitHub
+- `autorelease: snapshot` is special state for snapshot version bumps
+- `autorelease: published` means that a GitHub release has been published based on the Release PR (_release-please does not automatically add this tag, but we recommend it as a convention for publication tooling_).
 
 ## How should I write my commits?
 
@@ -112,7 +113,7 @@ commit message instead of the merged commit message.
 ## Release Please bot does not create a release PR. Why?
 
 Release Please creates a release pull request after it sees the default branch
-contains "releaseable units" since the last release.
+contains "releasable units" since the last release.
 A releasable unit is a commit to the branch with one of the following
 prefixes: "feat" and "fix". (A "chore" commit is not a releasable unit.)
 
@@ -123,13 +124,15 @@ Some languages have their specific releasable unit configuration. For example,
 
 Release Please automates releases for the following flavors of repositories:
 
-| release type            | description
-|-------------------|---------------------------------------------------------|
+| release type        | description |
+|---------------------|---------------------------------------------------------|
 | `dart`              | A repository with a pubspec.yaml and a CHANGELOG.md |
 | `elixir`            | A repository with a mix.exs and a CHANGELOG.md |
 | `go`                | A repository with a CHANGELOG.md |
 | `helm`              | A repository with a Chart.yaml and a CHANGELOG.md |
+| `java`              | [A strategy that generates SNAPSHOT version after each release](docs/java.md) |
 | `krm-blueprint`     | [A kpt package, with 1 or more KRM files and a CHANGELOG.md](https://github.com/GoogleCloudPlatform/blueprints/tree/main/catalog/project) |
+| `maven`             | [Strategy for Maven projects, generates SNAPSHOT version after each release and updates `pom.xml` automatically](docs/java.md) |
 | `node`              | [A Node.js repository, with a package.json and CHANGELOG.md](https://github.com/yargs/yargs) |
 | `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 |

package/build/src/bin/release-please.d.ts

@@ -41,6 +41,7 @@ interface ReleaseArgs {
     draft?: boolean;
     prerelease?: boolean;
     releaseLabel?: string;
+    snapshotLabel?: string;
     label?: string;
 }
 interface PullRequestArgs {

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

@@ -91,6 +91,11 @@ function releaseOptions(yargs) {
         describe: 'set a pull request label other than "autorelease: tagged"',
         default: 'autorelease: tagged',
         type: 'string',
+    })
+        .option('snapshot-label', {
+        describe: 'set a java snapshot pull request label other than "autorelease: snapshot"',
+        default: 'autorelease: snapshot',
+        type: 'string',
     });
 }
 function pullRequestOptions(yargs) {
@@ -505,6 +510,9 @@ function extractManifestOptions(argv) {
     if ('releaseLabel' in argv && argv.releaseLabel) {
         manifestOptions.releaseLabels = argv.releaseLabel.split(',');
     }
+    if ('snapshotLabel' in argv && argv.snapshotLabel) {
+        manifestOptions.snapshotLabels = argv.snapshotLabel.split(',');
+    }
     if ('signoff' in argv && argv.signoff) {
         manifestOptions.signoff = argv.signoff;
     }

package/build/src/factory.d.ts

@@ -3,7 +3,7 @@ import { GitHub } from './github';
 import { ReleaserConfig, PluginType, RepositoryConfig } from './manifest';
 import { ManifestPlugin } from './plugin';
 import { ChangelogNotes, ChangelogSection } from './changelog-notes';
-declare const allReleaseTypes: readonly ["dart", "dotnet-yoshi", "elixir", "go", "go-yoshi", "helm", "java-backport", "java-bom", "java-lts", "java-yoshi", "krm-blueprint", "node", "ocaml", "php", "php-yoshi", "python", "ruby", "ruby-yoshi", "rust", "simple", "terraform-module"];
+declare const allReleaseTypes: readonly ["dart", "dotnet-yoshi", "elixir", "go", "go-yoshi", "helm", "java", "java-backport", "java-bom", "java-lts", "java-yoshi", "krm-blueprint", "maven", "node", "ocaml", "php", "php-yoshi", "python", "ruby", "ruby-yoshi", "rust", "simple", "terraform-module"];
 export declare type ReleaseType = typeof allReleaseTypes[number];
 export declare function getReleaserTypes(): readonly ReleaseType[];
 export declare function getVersioningStrategyTypes(): readonly VersioningStrategyType[];

package/build/src/factory.js

@@ -41,6 +41,8 @@ const github_1 = require("./changelog-notes/github");
 const default_2 = require("./changelog-notes/default");
 const linked_versions_1 = require("./plugins/linked-versions");
 const dotnet_yoshi_1 = require("./strategies/dotnet-yoshi");
+const java_1 = require("./strategies/java");
+const maven_1 = require("./strategies/maven");
 // Factory shared by GitHub Action and CLI for creating Release PRs
 // and GitHub Releases:
 // add any new releasers you create to this type as well as the `releasers`
@@ -52,11 +54,13 @@ const allReleaseTypes = [
     'go',
     'go-yoshi',
     'helm',
+    'java',
     'java-backport',
     'java-bom',
     'java-lts',
     'java-yoshi',
     'krm-blueprint',
+    'maven',
     'node',
     'ocaml',
     'php',
@@ -72,7 +76,6 @@ const releasers = {
     'dotnet-yoshi': options => new dotnet_yoshi_1.DotnetYoshi(options),
     go: options => new go_1.Go(options),
     'go-yoshi': options => new go_yoshi_1.GoYoshi(options),
-    'java-yoshi': options => new java_yoshi_1.JavaYoshi(options),
     'krm-blueprint': options => new krm_blueprint_1.KRMBlueprint(options),
     node: options => new node_1.Node(options),
     ocaml: options => new ocaml_1.OCaml(options),
@@ -142,6 +145,24 @@ async function buildStrategy(options) {
                 versionFile: options.versionFile,
             });
         }
+        case 'java': {
+            return new java_1.Java({
+                ...strategyOptions,
+                snapshotLabels: options.snapshotLabels,
+            });
+        }
+        case 'maven': {
+            return new maven_1.Maven({
+                ...strategyOptions,
+                snapshotLabels: options.snapshotLabels,
+            });
+        }
+        case 'java-yoshi': {
+            return new java_yoshi_1.JavaYoshi({
+                ...strategyOptions,
+                snapshotLabels: options.snapshotLabels,
+            });
+        }
         case 'java-backport': {
             return new java_yoshi_1.JavaYoshi({
                 ...strategyOptions,

package/build/src/manifest.d.ts

@@ -15,7 +15,11 @@ declare type ExtraXmlFile = {
     path: string;
     xpath: string;
 };
-export declare type ExtraFile = string | ExtraJsonFile | ExtraXmlFile;
+declare type ExtraPomFile = {
+    type: 'pom';
+    path: string;
+};
+export declare type ExtraFile = string | ExtraJsonFile | ExtraXmlFile | ExtraPomFile;
 /**
  * These are configurations provided to each strategy per-path.
  */
@@ -40,6 +44,7 @@ export interface ReleaserConfig {
     changelogType?: ChangelogNotesType;
     versionFile?: string;
     extraFiles?: ExtraFile[];
+    snapshotLabels?: string[];
 }
 export interface CandidateReleasePullRequest {
     path: string;
@@ -71,6 +76,7 @@ interface ReleaserConfigJson {
     'tag-separator'?: string;
     'version-file'?: string;
     'extra-files'?: string[];
+    'snapshot-label'?: string;
 }
 export interface ManifestOptions {
     bootstrapSha?: string;
@@ -83,6 +89,7 @@ export interface ManifestOptions {
     manifestPath?: string;
     labels?: string[];
     releaseLabels?: string[];
+    snapshotLabels?: string[];
     draft?: boolean;
     prerelease?: boolean;
     draftPullRequest?: boolean;
@@ -117,6 +124,11 @@ export declare type RepositoryConfig = Record<string, ReleaserConfig>;
 export declare const DEFAULT_RELEASE_PLEASE_CONFIG = "release-please-config.json";
 export declare const DEFAULT_RELEASE_PLEASE_MANIFEST = ".release-please-manifest.json";
 export declare const ROOT_PROJECT_PATH = ".";
+export declare const DEFAULT_COMPONENT_NAME = "";
+export declare const DEFAULT_LABELS: string[];
+export declare const DEFAULT_RELEASE_LABELS: string[];
+export declare const DEFAULT_SNAPSHOT_LABELS: string[];
+export declare const SNOOZE_LABEL = "autorelease: snooze";
 export declare const MANIFEST_PULL_REQUEST_TITLE_PATTERN = "chore: release ${branch}";
 interface CreatedRelease extends GitHubRelease {
     path: string;
@@ -136,6 +148,7 @@ export declare class Manifest {
     private signoffUser?;
     private labels;
     private releaseLabels;
+    private snapshotLabels;
     private plugins;
     private _strategiesByPath?;
     private _pathsByComponent?;

package/build/src/manifest.js

@@ -13,7 +13,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Manifest = exports.MANIFEST_PULL_REQUEST_TITLE_PATTERN = exports.ROOT_PROJECT_PATH = exports.DEFAULT_RELEASE_PLEASE_MANIFEST = exports.DEFAULT_RELEASE_PLEASE_CONFIG = void 0;
+exports.Manifest = exports.MANIFEST_PULL_REQUEST_TITLE_PATTERN = exports.SNOOZE_LABEL = exports.DEFAULT_SNAPSHOT_LABELS = exports.DEFAULT_RELEASE_LABELS = exports.DEFAULT_LABELS = exports.DEFAULT_COMPONENT_NAME = exports.ROOT_PROJECT_PATH = exports.DEFAULT_RELEASE_PLEASE_MANIFEST = exports.DEFAULT_RELEASE_PLEASE_CONFIG = void 0;
 const version_1 = require("./version");
 const logger_1 = require("./util/logger");
 const commit_split_1 = require("./util/commit-split");
@@ -28,10 +28,11 @@ const errors_1 = require("./errors");
 exports.DEFAULT_RELEASE_PLEASE_CONFIG = 'release-please-config.json';
 exports.DEFAULT_RELEASE_PLEASE_MANIFEST = '.release-please-manifest.json';
 exports.ROOT_PROJECT_PATH = '.';
-const DEFAULT_COMPONENT_NAME = '';
-const DEFAULT_LABELS = ['autorelease: pending'];
-const DEFAULT_RELEASE_LABELS = ['autorelease: tagged'];
-const SNOOZE_LABEL = 'autorelease: snooze';
+exports.DEFAULT_COMPONENT_NAME = '';
+exports.DEFAULT_LABELS = ['autorelease: pending'];
+exports.DEFAULT_RELEASE_LABELS = ['autorelease: tagged'];
+exports.DEFAULT_SNAPSHOT_LABELS = ['autorelease: snapshot'];
+exports.SNOOZE_LABEL = 'autorelease: snooze';
 exports.MANIFEST_PULL_REQUEST_TITLE_PATTERN = 'chore: release ${branch}';
 class Manifest {
     /**
@@ -73,8 +74,10 @@ class Manifest {
         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 =
-            (manifestOptions === null || manifestOptions === void 0 ? void 0 : manifestOptions.releaseLabels) || DEFAULT_RELEASE_LABELS;
-        this.labels = (manifestOptions === null || manifestOptions === void 0 ? void 0 : manifestOptions.labels) || DEFAULT_LABELS;
+            (manifestOptions === null || manifestOptions === void 0 ? void 0 : manifestOptions.releaseLabels) || exports.DEFAULT_RELEASE_LABELS;
+        this.labels = (manifestOptions === null || manifestOptions === void 0 ? void 0 : manifestOptions.labels) || exports.DEFAULT_LABELS;
+        this.snapshotLabels =
+            (manifestOptions === null || manifestOptions === void 0 ? void 0 : manifestOptions.snapshotLabels) || exports.DEFAULT_SNAPSHOT_LABELS;
         this.bootstrapSha = manifestOptions === null || manifestOptions === void 0 ? void 0 : manifestOptions.bootstrapSha;
         this.lastReleaseSha = manifestOptions === null || manifestOptions === void 0 ? void 0 : manifestOptions.lastReleaseSha;
         this.draft = manifestOptions === null || manifestOptions === void 0 ? void 0 : manifestOptions.draft;
@@ -135,7 +138,7 @@ class Manifest {
         });
         const component = await strategy.getComponent();
         const releasedVersions = {};
-        const latestVersion = await latestReleaseVersion(github, targetBranch, config.includeComponentInTag ? component : '', config.pullRequestTitlePattern);
+        const latestVersion = await latestReleaseVersion(github, targetBranch, version => isPublishedVersion(strategy, version), config.includeComponentInTag ? component : '', config.pullRequestTitlePattern);
         if (latestVersion) {
             releasedVersions[path] = latestVersion;
         }
@@ -173,7 +176,7 @@ class Manifest {
                 logger_1.logger.warn(`Unable to parse release name: ${release.name}`);
                 continue;
             }
-            const component = tagName.component || DEFAULT_COMPONENT_NAME;
+            const component = tagName.component || exports.DEFAULT_COMPONENT_NAME;
             const path = pathsByComponent[component];
             if (!path) {
                 logger_1.logger.warn(`Found release tag with component '${component}', but not configured in manifest`);
@@ -321,7 +324,9 @@ class Manifest {
             const latestRelease = releasesByPath[path];
             const releasePullRequest = await strategy.buildReleasePullRequest(pathCommits, latestRelease, (_a = config.draftPullRequest) !== null && _a !== void 0 ? _a : this.draftPullRequest, this.labels);
             if (releasePullRequest) {
-                if (releasePullRequest.version) {
+                // Update manifest, but only for valid release version - this will skip SNAPSHOT from java strategy
+                if (releasePullRequest.version &&
+                    isPublishedVersion(strategy, releasePullRequest.version)) {
                     const versionsMap = new Map();
                     versionsMap.set(path, releasePullRequest.version);
                     releasePullRequest.updates.push({
@@ -415,7 +420,8 @@ class Manifest {
         const openPullRequests = [];
         const generator = this.github.pullRequestIterator(this.targetBranch, 'OPEN');
         for await (const openPullRequest of generator) {
-            if (hasAllLabels(this.labels, openPullRequest.labels) &&
+            if ((hasAllLabels(this.labels, openPullRequest.labels) ||
+                hasAllLabels(this.snapshotLabels, openPullRequest.labels)) &&
                 branch_name_1.BranchName.parse(openPullRequest.headBranchName) &&
                 pull_request_body_1.PullRequestBody.parse(openPullRequest.body)) {
                 openPullRequests.push(openPullRequest);
@@ -429,7 +435,7 @@ class Manifest {
         const snoozedPullRequests = [];
         const closedGenerator = this.github.pullRequestIterator(this.targetBranch, 'CLOSED');
         for await (const closedPullRequest of closedGenerator) {
-            if (hasAllLabels([SNOOZE_LABEL], closedPullRequest.labels) &&
+            if (hasAllLabels([exports.SNOOZE_LABEL], closedPullRequest.labels) &&
                 branch_name_1.BranchName.parse(closedPullRequest.headBranchName) &&
                 pull_request_body_1.PullRequestBody.parse(closedPullRequest.body)) {
                 snoozedPullRequests.push(closedPullRequest);
@@ -480,7 +486,7 @@ class Manifest {
             signoffUser: this.signoffUser,
         });
         // TODO: consider leaving the snooze label
-        await this.github.removeIssueLabels([SNOOZE_LABEL], snoozed.number);
+        await this.github.removeIssueLabels([exports.SNOOZE_LABEL], snoozed.number);
         return updatedPullRequest;
     }
     async *findMergedReleasePullRequests() {
@@ -694,6 +700,7 @@ async function parseConfig(github, configFile, branch) {
     }
     const configLabel = config['label'];
     const configReleaseLabel = config['release-label'];
+    const configSnapshotLabel = config['snapshot-label'];
     const manifestOptions = {
         bootstrapSha: config['bootstrap-sha'],
         lastReleaseSha: config['last-release-sha'],
@@ -703,6 +710,7 @@ async function parseConfig(github, configFile, branch) {
         plugins: config['plugins'],
         labels: configLabel === undefined ? undefined : [configLabel],
         releaseLabels: configReleaseLabel === undefined ? undefined : [configReleaseLabel],
+        snapshotLabels: configSnapshotLabel === undefined ? undefined : [configSnapshotLabel],
     };
     return { config: repositoryConfig, options: manifestOptions };
 }
@@ -721,16 +729,22 @@ async function parseReleasedVersions(github, manifestFile, branch) {
     }
     return releasedVersions;
 }
+function isPublishedVersion(strategy, version) {
+    return strategy.isPublishedVersion
+        ? strategy.isPublishedVersion(version)
+        : true;
+}
 /**
  * Find the most recent matching release tag on the branch we're
  * configured for.
  *
- * @param {string} prefix - Limit the release to a specific component.
- * @param {boolean} preRelease - Whether or not to return pre-release
- *   versions. Defaults to false.
+ * @param github GitHub client instance.
+ * @param {string} targetBranch Name of the scanned branch.
+ * @param releaseFilter Validator function for release version. Used to filter-out SNAPSHOT releases for Java strategy.
+ * @param {string} prefix Limit the release to a specific component.
+ * @param pullRequestTitlePattern Configured PR title pattern.
  */
-async function latestReleaseVersion(github, targetBranch, prefix, pullRequestTitlePattern) {
-    var _a;
+async function latestReleaseVersion(github, targetBranch, releaseFilter, prefix, pullRequestTitlePattern) {
     const branchPrefix = prefix
         ? prefix.endsWith('-')
             ? prefix.replace(/-$/, '')
@@ -765,11 +779,7 @@ async function latestReleaseVersion(github, targetBranch, prefix, pullRequestTit
             continue;
         }
         const version = pullRequestTitle.getVersion();
-        if ((_a = version === null || version === void 0 ? void 0 : version.preRelease) === null || _a === void 0 ? void 0 : _a.includes('SNAPSHOT')) {
-            // FIXME, don't hardcode this
-            continue;
-        }
-        if (version) {
+        if (version && releaseFilter(version)) {
             logger_1.logger.debug(`Found latest release pull request: ${mergedPullRequest.number} version: ${version}`);
             candidateReleaseVersions.push(version);
             break;

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

@@ -59,7 +59,7 @@ export declare abstract class BaseStrategy implements Strategy {
     private releaseAs?;
     protected includeComponentInTag: boolean;
     protected includeVInTag: boolean;
-    private pullRequestTitlePattern?;
+    readonly pullRequestTitlePattern?: string;
     readonly extraFiles: ExtraFile[];
     readonly changelogNotes: ChangelogNotes;
     protected changelogSections?: ChangelogSection[];
@@ -98,9 +98,9 @@ export declare abstract class BaseStrategy implements Strategy {
      *   open a pull request.
      */
     buildReleasePullRequest(commits: Commit[], latestRelease?: Release, draft?: boolean, labels?: string[]): Promise<ReleasePullRequest | undefined>;
-    private extraFileUpdates;
+    protected extraFileUpdates(version: Version, versionsMap: VersionsMap): Update[];
     protected changelogEmpty(changelogEntry: string): boolean;
-    protected updateVersionsMap(versionsMap: VersionsMap, conventionalCommits: ConventionalCommit[]): Promise<VersionsMap>;
+    protected updateVersionsMap(versionsMap: VersionsMap, conventionalCommits: ConventionalCommit[], _newVersion: Version): Promise<VersionsMap>;
     protected buildNewVersion(conventionalCommits: ConventionalCommit[], latestRelease?: Release): Promise<Version>;
     protected buildVersionsMap(_conventionalCommits: ConventionalCommit[]): Promise<VersionsMap>;
     protected parsePullRequestBody(pullRequestBody: string): Promise<PullRequestBody | undefined>;

package/build/src/strategies/base.js

@@ -28,6 +28,7 @@ const composite_1 = require("../updaters/composite");
 const generic_1 = require("../updaters/generic");
 const generic_json_1 = require("../updaters/generic-json");
 const generic_xml_1 = require("../updaters/generic-xml");
+const pom_xml_1 = require("../updaters/java/pom-xml");
 const DEFAULT_CHANGELOG_PATH = 'CHANGELOG.md';
 /**
  * A strategy is responsible for determining which files are
@@ -134,7 +135,7 @@ class BaseStrategy {
             return undefined;
         }
         const newVersion = await this.buildNewVersion(conventionalCommits, latestRelease);
-        const versionsMap = await this.updateVersionsMap(await this.buildVersionsMap(conventionalCommits), conventionalCommits);
+        const versionsMap = await this.updateVersionsMap(await this.buildVersionsMap(conventionalCommits), conventionalCommits, newVersion);
         const component = await this.getComponent();
         logger_1.logger.debug('component:', component);
         const newVersionTag = new tag_name_1.TagName(newVersion, this.includeComponentInTag ? component : undefined, this.tagSeparator, this.includeVInTag);
@@ -154,7 +155,7 @@ class BaseStrategy {
             versionsMap,
             latestVersion: latestRelease === null || latestRelease === void 0 ? void 0 : latestRelease.tag.version,
         });
-        const updatesWithExtras = composite_1.mergeUpdates(updates.concat(...this.extraFileUpdates(newVersion)));
+        const updatesWithExtras = composite_1.mergeUpdates(updates.concat(...this.extraFileUpdates(newVersion, versionsMap)));
         const pullRequestBody = await this.buildPullRequestBody(component, newVersion, releaseNotesBody, conventionalCommits, latestRelease);
         return {
             title: pullRequestTitle,
@@ -166,7 +167,7 @@ class BaseStrategy {
             draft: draft !== null && draft !== void 0 ? draft : false,
         };
     }
-    extraFileUpdates(version) {
+    extraFileUpdates(version, versionsMap) {
         return this.extraFiles.map(extraFile => {
             if (typeof extraFile === 'object') {
                 switch (extraFile.type) {
@@ -182,6 +183,12 @@ class BaseStrategy {
                             createIfMissing: false,
                             updater: new generic_xml_1.GenericXml(extraFile.xpath, version),
                         };
+                    case 'pom':
+                        return {
+                            path: this.addPath(extraFile.path),
+                            createIfMissing: false,
+                            updater: new pom_xml_1.PomXml(version),
+                        };
                     default:
                         throw new Error(`unsupported extraFile type: ${extraFile.type}`);
                 }
@@ -189,14 +196,14 @@ class BaseStrategy {
             return {
                 path: this.addPath(extraFile),
                 createIfMissing: false,
-                updater: new generic_1.Generic({ version }),
+                updater: new generic_1.Generic({ version, versionsMap }),
             };
         });
     }
     changelogEmpty(changelogEntry) {
         return changelogEntry.split('\n').length <= 1;
     }
-    async updateVersionsMap(versionsMap, conventionalCommits) {
+    async updateVersionsMap(versionsMap, conventionalCommits, _newVersion) {
         for (const versionKey of versionsMap.keys()) {
             const version = versionsMap.get(versionKey);
             if (!version) {

package/build/src/strategies/java-yoshi.d.ts

@@ -1,30 +1,20 @@
 import { Update } from '../update';
 import { Version, VersionsMap } from '../version';
-import { BaseStrategy, BuildUpdatesOptions, BaseStrategyOptions } from './base';
 import { GitHubFileContents } from '../util/file-cache';
-import { Commit, ConventionalCommit } from '../commit';
-import { Release } from '../release';
-import { ReleasePullRequest } from '../release-pull-request';
-interface JavaBuildUpdatesOption extends BuildUpdatesOptions {
-    isSnapshot?: boolean;
-}
-export declare class JavaYoshi extends BaseStrategy {
+import { ConventionalCommit } from '../commit';
+import { Java, JavaBuildUpdatesOption } from './java';
+export declare class JavaYoshi extends Java {
     private versionsContent?;
-    private snapshotVersioning;
-    constructor(options: BaseStrategyOptions);
-    buildReleasePullRequest(commits: Commit[], latestRelease?: Release, draft?: boolean, labels?: string[]): Promise<ReleasePullRequest | undefined>;
-    private buildSnapshotPullRequest;
     /**
      * Override this method to post process commits
      * @param {ConventionalCommit[]} commits parsed commits
      * @returns {ConventionalCommit[]} modified commits
      */
     protected postProcessCommits(commits: ConventionalCommit[]): Promise<ConventionalCommit[]>;
-    private needsSnapshot;
+    protected needsSnapshot(): Promise<boolean>;
     protected buildVersionsMap(): Promise<VersionsMap>;
     protected getVersionsContent(): Promise<GitHubFileContents>;
     protected buildUpdates(options: JavaBuildUpdatesOption): Promise<Update[]>;
     protected updateVersionsMap(versionsMap: VersionsMap, conventionalCommits: ConventionalCommit[]): Promise<VersionsMap>;
     protected initialReleaseVersion(): Version;
 }
-export {};

package/build/src/strategies/java-yoshi.js

@@ -16,92 +16,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.JavaYoshi = void 0;
 const versions_manifest_1 = require("../updaters/java/versions-manifest");
 const version_1 = require("../version");
-const java_update_1 = require("../updaters/java/java-update");
-const base_1 = require("./base");
 const changelog_1 = require("../updaters/changelog");
-const java_snapshot_1 = require("../versioning-strategies/java-snapshot");
 const errors_1 = require("../errors");
 const logger_1 = require("../util/logger");
-const pull_request_title_1 = require("../util/pull-request-title");
-const branch_name_1 = require("../util/branch-name");
-const pull_request_body_1 = require("../util/pull-request-body");
-const default_1 = require("../versioning-strategies/default");
-const java_add_snapshot_1 = require("../versioning-strategies/java-add-snapshot");
-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 JavaYoshi extends base_1.BaseStrategy {
-    constructor(options) {
-        var _a;
-        options.changelogSections = (_a = options.changelogSections) !== null && _a !== void 0 ? _a : CHANGELOG_SECTIONS;
-        // wrap the configured versioning strategy with snapshotting
-        const parentVersioningStrategy = options.versioningStrategy || new default_1.DefaultVersioningStrategy();
-        options.versioningStrategy = new java_snapshot_1.JavaSnapshot(parentVersioningStrategy);
-        super(options);
-        this.snapshotVersioning = new java_add_snapshot_1.JavaAddSnapshot(parentVersioningStrategy);
-    }
-    async buildReleasePullRequest(commits, latestRelease, draft, labels = []) {
-        if (await this.needsSnapshot()) {
-            logger_1.logger.info('Repository needs a snapshot bump.');
-            return await this.buildSnapshotPullRequest(latestRelease);
-        }
-        logger_1.logger.info('No Java snapshot needed');
-        return await super.buildReleasePullRequest(commits, latestRelease, draft, labels);
-    }
-    async buildSnapshotPullRequest(latestRelease) {
-        const component = await this.getComponent();
-        const newVersion = latestRelease
-            ? await this.snapshotVersioning.bump(latestRelease.tag.version, [])
-            : this.initialReleaseVersion();
-        const versionsMap = await this.buildVersionsMap();
-        for (const versionKey of versionsMap.keys()) {
-            const version = versionsMap.get(versionKey);
-            if (!version) {
-                logger_1.logger.warn(`didn't find version for ${versionKey}`);
-                continue;
-            }
-            const newVersion = await this.snapshotVersioning.bump(version, []);
-            versionsMap.set(versionKey, newVersion);
-        }
-        const pullRequestTitle = pull_request_title_1.PullRequestTitle.ofComponentTargetBranchVersion(component || '', this.targetBranch, newVersion);
-        const branchName = component
-            ? branch_name_1.BranchName.ofComponentTargetBranch(component, this.targetBranch)
-            : branch_name_1.BranchName.ofTargetBranch(this.targetBranch);
-        const notes = '### Updating meta-information for bleeding-edge SNAPSHOT release.';
-        const pullRequestBody = new pull_request_body_1.PullRequestBody([
-            {
-                component,
-                version: newVersion,
-                notes,
-            },
-        ]);
-        const updates = await this.buildUpdates({
-            newVersion,
-            versionsMap,
-            changelogEntry: notes,
-            isSnapshot: true,
-        });
-        return {
-            title: pullRequestTitle,
-            body: pullRequestBody,
-            updates,
-            labels: [],
-            headRefName: branchName.toString(),
-            version: newVersion,
-            draft: false,
-        };
-    }
+const java_1 = require("./java");
+const java_update_1 = require("../updaters/java/java-update");
+class JavaYoshi extends java_1.Java {
     /**
      * Override this method to post process commits
      * @param {ConventionalCommit[]} commits parsed commits

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

@@ -0,0 +1,28 @@
+import { Update } from '../update';
+import { Version } from '../version';
+import { BaseStrategy, BaseStrategyOptions, BuildUpdatesOptions } from './base';
+import { Commit } from '../commit';
+import { Release } from '../release';
+import { ReleasePullRequest } from '../release-pull-request';
+import { VersioningStrategy } from '../versioning-strategy';
+export interface JavaStrategyOptions extends BaseStrategyOptions {
+    snapshotLabels?: string[];
+}
+export interface JavaBuildUpdatesOption extends BuildUpdatesOptions {
+    isSnapshot?: boolean;
+}
+/**
+ * A strategy that generates SNAPSHOT version after each release, which is standard especially in Maven projects.
+ *
+ * This is universal strategy that does not update any files on its own. Use maven strategy for Maven projects.
+ */
+export declare class Java extends BaseStrategy {
+    protected readonly snapshotVersioning: VersioningStrategy;
+    protected readonly snapshotLabels: string[];
+    constructor(options: JavaStrategyOptions);
+    buildReleasePullRequest(commits: Commit[], latestRelease?: Release, draft?: boolean, labels?: string[]): Promise<ReleasePullRequest | undefined>;
+    protected buildSnapshotPullRequest(latestRelease?: Release, draft?: boolean, labels?: string[]): Promise<ReleasePullRequest>;
+    isPublishedVersion(version: Version): boolean;
+    protected needsSnapshot(commits: Commit[], latestRelease?: Release): Promise<boolean>;
+    protected buildUpdates(options: JavaBuildUpdatesOption): Promise<Update[]>;
+}

package/build/src/strategies/java.js

@@ -0,0 +1,160 @@
+"use strict";
+// Copyright 2022 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.Java = void 0;
+const base_1 = require("./base");
+const changelog_1 = require("../updaters/changelog");
+const java_snapshot_1 = require("../versioning-strategies/java-snapshot");
+const logger_1 = require("../util/logger");
+const pull_request_title_1 = require("../util/pull-request-title");
+const branch_name_1 = require("../util/branch-name");
+const pull_request_body_1 = require("../util/pull-request-body");
+const default_1 = require("../versioning-strategies/default");
+const java_add_snapshot_1 = require("../versioning-strategies/java-add-snapshot");
+const manifest_1 = require("../manifest");
+const java_released_1 = require("../updaters/java/java-released");
+const composite_1 = require("../updaters/composite");
+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 },
+];
+/**
+ * A strategy that generates SNAPSHOT version after each release, which is standard especially in Maven projects.
+ *
+ * This is universal strategy that does not update any files on its own. Use maven strategy for Maven projects.
+ */
+class Java extends base_1.BaseStrategy {
+    constructor(options) {
+        var _a;
+        options.changelogSections = (_a = options.changelogSections) !== null && _a !== void 0 ? _a : CHANGELOG_SECTIONS;
+        // wrap the configured versioning strategy with snapshotting
+        const parentVersioningStrategy = options.versioningStrategy || new default_1.DefaultVersioningStrategy();
+        options.versioningStrategy = new java_snapshot_1.JavaSnapshot(parentVersioningStrategy);
+        super(options);
+        this.snapshotVersioning = new java_add_snapshot_1.JavaAddSnapshot(parentVersioningStrategy);
+        this.snapshotLabels = options.snapshotLabels || manifest_1.DEFAULT_SNAPSHOT_LABELS;
+    }
+    async buildReleasePullRequest(commits, latestRelease, draft, labels = []) {
+        if (await this.needsSnapshot(commits, latestRelease)) {
+            logger_1.logger.info('Repository needs a snapshot bump.');
+            return await this.buildSnapshotPullRequest(latestRelease, draft, this.snapshotLabels);
+        }
+        logger_1.logger.info('No Java snapshot needed');
+        return await super.buildReleasePullRequest(commits, latestRelease, draft, labels);
+    }
+    async buildSnapshotPullRequest(latestRelease, draft, labels = []) {
+        const component = await this.getComponent();
+        const newVersion = latestRelease
+            ? await this.snapshotVersioning.bump(latestRelease.tag.version, [])
+            : this.initialReleaseVersion();
+        const versionsMap = await this.buildVersionsMap([]);
+        const pullRequestTitle = pull_request_title_1.PullRequestTitle.ofComponentTargetBranchVersion(component || '', this.targetBranch, newVersion);
+        const branchName = component
+            ? branch_name_1.BranchName.ofComponentTargetBranch(component, this.targetBranch)
+            : branch_name_1.BranchName.ofTargetBranch(this.targetBranch);
+        const notes = '### Updating meta-information for bleeding-edge SNAPSHOT release.';
+        const pullRequestBody = new pull_request_body_1.PullRequestBody([
+            {
+                component,
+                version: newVersion,
+                notes,
+            },
+        ]);
+        const updates = await this.buildUpdates({
+            newVersion,
+            versionsMap,
+            changelogEntry: notes,
+            isSnapshot: true,
+        });
+        const updatesWithExtras = composite_1.mergeUpdates(updates.concat(...this.extraFileUpdates(newVersion, versionsMap)));
+        return {
+            title: pullRequestTitle,
+            body: pullRequestBody,
+            updates: updatesWithExtras,
+            labels: labels,
+            headRefName: branchName.toString(),
+            version: newVersion,
+            draft: draft !== null && draft !== void 0 ? draft : false,
+        };
+    }
+    isPublishedVersion(version) {
+        return !version.preRelease || version.preRelease.indexOf('SNAPSHOT') < 0;
+    }
+    async needsSnapshot(commits, latestRelease) {
+        var _a;
+        const component = await this.getComponent();
+        logger_1.logger.debug('component:', component);
+        const version = (_a = latestRelease === null || latestRelease === void 0 ? void 0 : latestRelease.tag) === null || _a === void 0 ? void 0 : _a.version;
+        if (!version) {
+            // Don't bump snapshots for the first release ever
+            return false;
+        }
+        // Found snapshot as a release, this is unexpected, but use it
+        if (!this.isPublishedVersion(version)) {
+            return false;
+        }
+        // Search commits for snapshot bump
+        const pullRequests = commits
+            .map(commit => {
+            var _a;
+            return pull_request_title_1.PullRequestTitle.parse(((_a = commit.pullRequest) === null || _a === void 0 ? void 0 : _a.title) || commit.message, this.pullRequestTitlePattern);
+        })
+            .filter(pullRequest => pullRequest);
+        const snapshotCommits = pullRequests
+            .filter(pullRequest => ((pullRequest === null || pullRequest === void 0 ? void 0 : pullRequest.component) || '') === component)
+            .map(pullRequest => pullRequest === null || pullRequest === void 0 ? void 0 : pullRequest.getVersion())
+            .filter(version => version && !this.isPublishedVersion(version));
+        return snapshotCommits.length === 0;
+    }
+    async buildUpdates(options) {
+        const version = options.newVersion;
+        const versionsMap = options.versionsMap;
+        const updates = [];
+        if (!options.isSnapshot) {
+            // Append java-specific updater for extraFiles
+            this.extraFiles.forEach(extraFile => {
+                if (typeof extraFile === 'string') {
+                    updates.push({
+                        path: this.addPath(extraFile),
+                        createIfMissing: false,
+                        updater: new java_released_1.JavaReleased({ version, versionsMap }),
+                    });
+                }
+            });
+            // Update changelog
+            updates.push({
+                path: this.addPath(this.changelogPath),
+                createIfMissing: true,
+                updater: new changelog_1.Changelog({
+                    version,
+                    changelogEntry: options.changelogEntry,
+                }),
+            });
+        }
+        return updates;
+    }
+}
+exports.Java = Java;
+//# sourceMappingURL=java.js.map

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

@@ -0,0 +1,9 @@
+import { Java, JavaBuildUpdatesOption } from './java';
+import { Update } from '../update';
+/**
+ * Strategy for Maven projects. It generates SNAPSHOT version after each release, and updates all found
+ * pom.xml files automatically.
+ */
+export declare class Maven extends Java {
+    protected buildUpdates(options: JavaBuildUpdatesOption): Promise<Update[]>;
+}

package/build/src/strategies/maven.js

@@ -0,0 +1,56 @@
+"use strict";
+// Copyright 2022 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.Maven = void 0;
+const java_1 = require("./java");
+const java_released_1 = require("../updaters/java/java-released");
+const generic_1 = require("../updaters/generic");
+const pom_xml_1 = require("../updaters/java/pom-xml");
+/**
+ * Strategy for Maven projects. It generates SNAPSHOT version after each release, and updates all found
+ * pom.xml files automatically.
+ */
+class Maven extends java_1.Java {
+    async buildUpdates(options) {
+        const version = options.newVersion;
+        const versionsMap = options.versionsMap;
+        // Use generic Java updates
+        const updates = await super.buildUpdates(options);
+        // Update pom.xml files
+        const pomFiles = await this.github.findFilesByFilenameAndRef('pom.xml', this.targetBranch, this.path);
+        pomFiles.forEach(path => {
+            updates.push({
+                path: this.addPath(path),
+                createIfMissing: false,
+                updater: new pom_xml_1.PomXml(version),
+            });
+            if (!options.isSnapshot) {
+                updates.push({
+                    path: this.addPath(path),
+                    createIfMissing: false,
+                    updater: new java_released_1.JavaReleased({ version, versionsMap }),
+                });
+            }
+            updates.push({
+                path: this.addPath(path),
+                createIfMissing: false,
+                updater: new generic_1.Generic({ version, versionsMap }),
+            });
+        });
+        return updates;
+    }
+}
+exports.Maven = Maven;
+//# sourceMappingURL=maven.js.map

package/build/src/strategy.d.ts

@@ -4,6 +4,7 @@ import { PullRequest } from './pull-request';
 import { Commit } from './commit';
 import { VersioningStrategy } from './versioning-strategy';
 import { ChangelogNotes } from './changelog-notes';
+import { Version } from './version';
 /**
  * A strategy is responsible for determining which files are
  * necessary to update in a release pull request.
@@ -35,4 +36,10 @@ export interface Strategy {
      * @returns {string}
      */
     getComponent(): Promise<string | undefined>;
+    /**
+     * Validate whether version is a valid release.
+     * @param version Released version.
+     * @returns true of release is valid, false if it should be skipped.
+     */
+    isPublishedVersion?(version: Version): boolean;
 }

package/build/src/updaters/base-xml.d.ts

@@ -0,0 +1,19 @@
+import { Updater } from '../update';
+/**
+ * Base class for all updaters working with XML files.
+ */
+export declare abstract class BaseXml implements Updater {
+    /**
+     * Given initial file contents, return updated contents.
+     * @param {string} content The initial content
+     * @returns {string} The updated content
+     */
+    updateContent(content: string): string;
+    /**
+     * Updates the document in-place if needed.
+     * @param document Document to be modified.
+     * @return true if document has been changed and therefore file needs to be changed, false otherwise.
+     * @protected
+     */
+    protected abstract updateDocument(document: Document): boolean;
+}

package/build/src/updaters/base-xml.js

@@ -0,0 +1,39 @@
+"use strict";
+// Copyright 2022 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.BaseXml = void 0;
+const dom = require("xmldom");
+/**
+ * Base class for all updaters working with XML files.
+ */
+class BaseXml {
+    /**
+     * Given initial file contents, return updated contents.
+     * @param {string} content The initial content
+     * @returns {string} The updated content
+     */
+    updateContent(content) {
+        const document = new dom.DOMParser().parseFromString(content);
+        const updated = this.updateDocument(document);
+        if (updated) {
+            return new dom.XMLSerializer().serializeToString(document);
+        }
+        else {
+            return content;
+        }
+    }
+}
+exports.BaseXml = BaseXml;
+//# sourceMappingURL=base-xml.js.map

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

@@ -1,13 +1,8 @@
-import { Updater } from '../update';
 import { Version } from '../version';
-export declare class GenericXml implements Updater {
-    private xpath;
-    private version;
+import { BaseXml } from './base-xml';
+export declare class GenericXml extends BaseXml {
+    private readonly xpath;
+    private readonly version;
     constructor(xpath: string, version: Version);
-    /**
-     * Given initial file contents, return updated contents.
-     * @param {string} content The initial content
-     * @returns {string} The updated content
-     */
-    updateContent(content: string): string;
+    protected updateDocument(document: Document): boolean;
 }

package/build/src/updaters/generic-xml.js

@@ -14,33 +14,24 @@
 // limitations under the License.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.GenericXml = void 0;
+const base_xml_1 = require("./base-xml");
 const xpath = require("xpath");
-const dom = require("xmldom");
-class GenericXml {
+class GenericXml extends base_xml_1.BaseXml {
     constructor(xpath, version) {
+        super();
         this.xpath = xpath;
         this.version = version;
     }
-    /**
-     * Given initial file contents, return updated contents.
-     * @param {string} content The initial content
-     * @returns {string} The updated content
-     */
-    updateContent(content) {
-        const document = new dom.DOMParser().parseFromString(content);
-        const iterator = xpath.evaluate(this.xpath, document, null, 0, null);
-        let node;
+    updateDocument(document) {
+        const version = this.version.toString();
         let updated = false;
-        while ((node = iterator.iterateNext())) {
-            node.textContent = this.version.toString();
-            updated = true;
-        }
-        if (updated) {
-            return new dom.XMLSerializer().serializeToString(document);
-        }
-        else {
-            return content;
+        for (const node of xpath.select(this.xpath, document)) {
+            if (node.textContent !== version) {
+                node.textContent = version;
+                updated = true;
+            }
         }
+        return updated;
     }
 }
 exports.GenericXml = GenericXml;

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

@@ -1,4 +1,12 @@
-import { DefaultUpdater } from './default';
+import { DefaultUpdater, UpdateOptions } from './default';
+/**
+ * Options for the Generic updater.
+ */
+export interface GenericUpdateOptions extends UpdateOptions {
+    inlineUpdateRegex?: RegExp;
+    blockStartRegex?: RegExp;
+    blockEndRegex?: RegExp;
+}
 /**
  * The Generic updater looks for well known patterns and replaces
  * content. The well known patterns are:
@@ -7,13 +15,13 @@ import { DefaultUpdater } from './default';
  *    then replace a semver-looking string on that line with the next
  *    version
  * 2. `x-release-please-major` if this string is found on the line,
- *    then replace an integer looking value with the the next version's
+ *    then replace an integer looking value with the next version's
  *    major
  * 3. `x-release-please-minor` if this string is found on the line,
- *    then replace an integer looking value with the the next version's
+ *    then replace an integer looking value with the next version's
  *    minor
  * 4. `x-release-please-patch` if this string is found on the line,
- *    then replace an integer looking value with the the next version's
+ *    then replace an integer looking value with the next version's
  *    patch
  *
  * You can also use a block-based replacement. Content between the
@@ -23,6 +31,10 @@ import { DefaultUpdater } from './default';
  * numbers
  */
 export declare class Generic extends DefaultUpdater {
+    private readonly inlineUpdateRegex;
+    private readonly blockStartRegex;
+    private readonly blockEndRegex;
+    constructor(options: GenericUpdateOptions);
     /**
      * Given initial file contents, return updated contents.
      * @param {string} content The initial content

package/build/src/updaters/generic.js

@@ -29,13 +29,13 @@ const BLOCK_END_REGEX = /x-release-please-end/;
  *    then replace a semver-looking string on that line with the next
  *    version
  * 2. `x-release-please-major` if this string is found on the line,
- *    then replace an integer looking value with the the next version's
+ *    then replace an integer looking value with the next version's
  *    major
  * 3. `x-release-please-minor` if this string is found on the line,
- *    then replace an integer looking value with the the next version's
+ *    then replace an integer looking value with the next version's
  *    minor
  * 4. `x-release-please-patch` if this string is found on the line,
- *    then replace an integer looking value with the the next version's
+ *    then replace an integer looking value with the next version's
  *    patch
  *
  * You can also use a block-based replacement. Content between the
@@ -45,6 +45,13 @@ const BLOCK_END_REGEX = /x-release-please-end/;
  * numbers
  */
 class Generic extends default_1.DefaultUpdater {
+    constructor(options) {
+        var _a, _b, _c;
+        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;
+    }
     /**
      * Given initial file contents, return updated contents.
      * @param {string} content The initial content
@@ -77,7 +84,7 @@ class Generic extends default_1.DefaultUpdater {
         }
         content.split(/\r?\n/).forEach(line => {
             var _a, _b;
-            let match = line.match(INLINE_UPDATE_REGEX);
+            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);
@@ -85,13 +92,13 @@ class Generic extends default_1.DefaultUpdater {
             else if (blockScope) {
                 // in a block, so try to replace versions
                 replaceVersion(line, blockScope, this.version);
-                if (line.match(BLOCK_END_REGEX)) {
+                if (line.match(this.blockEndRegex)) {
                     blockScope = undefined;
                 }
             }
             else {
                 // look for block start line
-                match = line.match(BLOCK_START_REGEX);
+                match = line.match(this.blockStartRegex);
                 if (match) {
                     if ((_b = match.groups) === null || _b === void 0 ? void 0 : _b.scope) {
                         blockScope = match.groups.scope;

package/build/src/updaters/java/java-released.d.ts

@@ -0,0 +1,28 @@
+import { Generic, GenericUpdateOptions } from '../generic';
+/**
+ * The JavaReleased updater is used only when updating to stable (not SNAPSHOT)
+ * versions. It looks for well known patterns and replaces content.
+ * The well known patterns are:
+ *
+ * 1. `x-release-please-released-version` if this string is found on the line,
+ *    then replace a semver-looking string on that line with the next
+ *    version
+ * 2. `x-release-please-released-major` if this string is found on the line,
+ *    then replace an integer looking value with the next version's
+ *    major
+ * 3. `x-release-please-released-minor` if this string is found on the line,
+ *    then replace an integer looking value with the next version's
+ *    minor
+ * 4. `x-release-please-released-patch` if this string is found on the line,
+ *    then replace an integer looking value with the next version's
+ *    patch
+ *
+ * You can also use a block-based replacement. Content between the
+ * opening `x-release-please-released-start-version` and `x-release-please-released-end` will
+ * be considered for version replacement. You can also open these blocks
+ * with `x-release-please-released-start-<major|minor|patch>` to replace single
+ * numbers
+ */
+export declare class JavaReleased extends Generic {
+    constructor(options: GenericUpdateOptions);
+}

package/build/src/updaters/java/java-released.js

@@ -0,0 +1,59 @@
+"use strict";
+// Copyright 2022 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.JavaReleased = void 0;
+const generic_1 = require("../generic");
+const INLINE_UPDATE_REGEX = /x-release-please-released-(?<scope>major|minor|patch|version)/;
+const BLOCK_START_REGEX = /x-release-please-released-start-(?<scope>major|minor|patch|version)/;
+const BLOCK_END_REGEX = /x-release-please-released-end/;
+const REGEX_OPTIONS = {
+    inlineUpdateRegex: INLINE_UPDATE_REGEX,
+    blockStartRegex: BLOCK_START_REGEX,
+    blockEndRegex: BLOCK_END_REGEX,
+};
+/**
+ * The JavaReleased updater is used only when updating to stable (not SNAPSHOT)
+ * versions. It looks for well known patterns and replaces content.
+ * The well known patterns are:
+ *
+ * 1. `x-release-please-released-version` if this string is found on the line,
+ *    then replace a semver-looking string on that line with the next
+ *    version
+ * 2. `x-release-please-released-major` if this string is found on the line,
+ *    then replace an integer looking value with the next version's
+ *    major
+ * 3. `x-release-please-released-minor` if this string is found on the line,
+ *    then replace an integer looking value with the next version's
+ *    minor
+ * 4. `x-release-please-released-patch` if this string is found on the line,
+ *    then replace an integer looking value with the next version's
+ *    patch
+ *
+ * You can also use a block-based replacement. Content between the
+ * opening `x-release-please-released-start-version` and `x-release-please-released-end` will
+ * be considered for version replacement. You can also open these blocks
+ * with `x-release-please-released-start-<major|minor|patch>` to replace single
+ * numbers
+ */
+class JavaReleased extends generic_1.Generic {
+    constructor(options) {
+        super({
+            ...REGEX_OPTIONS,
+            ...options,
+        });
+    }
+}
+exports.JavaReleased = JavaReleased;
+//# sourceMappingURL=java-released.js.map

package/build/src/updaters/java/pom-xml.d.ts

@@ -0,0 +1,14 @@
+import { Version } from '../../version';
+import { BaseXml } from '../base-xml';
+/**
+ * Updates version pom.xml files.
+ *
+ * If present it updates project.version element.
+ * If project.version is not present, it updates project.parent.version.
+ */
+export declare class PomXml extends BaseXml {
+    private readonly version;
+    constructor(version: Version);
+    protected updateDocument(document: Document): boolean;
+    private static updateNodes;
+}

package/build/src/updaters/java/pom-xml.js

@@ -0,0 +1,52 @@
+"use strict";
+// Copyright 2022 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.PomXml = void 0;
+const base_xml_1 = require("../base-xml");
+const xpath = require("xpath");
+const XPATH_PROJECT_VERSION = '/*[local-name()="project"]/*[local-name()="version"]';
+const XPATH_PROJECT_PARENT_VERSION = '/*[local-name()="project"]/*[local-name()="parent"]/*[local-name()="version"]';
+/**
+ * Updates version pom.xml files.
+ *
+ * If present it updates project.version element.
+ * If project.version is not present, it updates project.parent.version.
+ */
+class PomXml extends base_xml_1.BaseXml {
+    constructor(version) {
+        super();
+        this.version = version;
+    }
+    updateDocument(document) {
+        const version = this.version.toString();
+        // NOTE this intentionally ignores namespaces - let the maven decide, what's valid and what's not
+        // Update project.version
+        const projectVersionNodes = xpath.select(XPATH_PROJECT_VERSION, document);
+        if (projectVersionNodes.length) {
+            // If found update, detect actual change
+            return PomXml.updateNodes(projectVersionNodes, version);
+        }
+        // Try updating project.parent.version
+        const parentVersionNodes = xpath.select(XPATH_PROJECT_PARENT_VERSION, document);
+        return PomXml.updateNodes(parentVersionNodes, version);
+    }
+    static updateNodes(nodes, value) {
+        const toUpdate = nodes.filter(node => node.textContent !== value);
+        toUpdate.forEach(node => (node.textContent = value));
+        return toUpdate.length > 0;
+    }
+}
+exports.PomXml = PomXml;
+//# sourceMappingURL=pom-xml.js.map

package/package.json

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