release-please 13.1.1 → 13.2.0

package/CHANGELOG.md

@@ -4,6 +4,18 @@
 
 [1]: https://www.npmjs.com/package/release-please?activeTab=versions
 
+## [13.2.0](https://github.com/googleapis/release-please/compare/v13.1.1...v13.2.0) (2022-01-11)
+
+
+### Features
+
+* allow prerelease releases on Github ([#1181](https://github.com/googleapis/release-please/issues/1181)) ([267dbfc](https://github.com/googleapis/release-please/commit/267dbfc58a50cde7ffa378b357df62066a1218c9))
+
+
+### Bug Fixes
+
+* java snapshots should update all files with :current annotations ([#1204](https://github.com/googleapis/release-please/issues/1204)) ([6f3ae8b](https://github.com/googleapis/release-please/commit/6f3ae8b58afb6673dab2f49daa3d17fbbbef352c))
+
 ### [13.1.1](https://www.github.com/googleapis/release-please/compare/v13.1.0...v13.1.1) (2022-01-03)
 
 

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

@@ -39,6 +39,7 @@ interface ManifestConfigArgs {
 }
 interface ReleaseArgs {
     draft?: boolean;
+    prerelease?: boolean;
     releaseLabel?: string;
     label?: string;
 }

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

@@ -76,6 +76,12 @@ function releaseOptions(yargs) {
             'tag creation upon "un-drafting" the release.',
         type: 'boolean',
         default: false,
+    })
+        .option('prerelease', {
+        describe: 'mark release that have prerelease versions ' +
+            'as as a prerelease on Github',
+        type: 'boolean',
+        default: false,
     })
         .option('label', {
         default: 'autorelease: pending',
@@ -316,6 +322,7 @@ const createReleaseCommand = {
                 component: argv.component,
                 packageName: argv.packageName,
                 draft: argv.draft,
+                prerelease: argv.prerelease,
                 includeComponentInTag: argv.monorepoTags,
             }, extractManifestOptions(argv), argv.path);
         }
@@ -419,6 +426,7 @@ const bootstrapCommand = {
             component: argv.component,
             packageName: argv.packageName,
             draft: argv.draft,
+            prerelease: argv.prerelease,
             draftPullRequest: argv.draftPullRequest,
             bumpMinorPreMajor: argv.bumpMinorPreMajor,
             bumpPatchForMinorPreMajor: argv.bumpPatchForMinorPreMajor,

package/build/src/github.d.ts

@@ -46,6 +46,10 @@ interface ReleaseIteratorOptions {
 interface TagIteratorOptions {
     maxResults?: number;
 }
+export interface ReleaseOptions {
+    draft?: boolean;
+    prerelease?: boolean;
+}
 export interface GitHubRelease {
     name?: string;
     tagName: string;
@@ -306,13 +310,11 @@ export declare class GitHub {
      * Create a GitHub release
      *
      * @param {Release} release Release parameters
-     * @param {boolean} draft Whether or not to create the release as a draft
+     * @param {ReleaseOptions} options Release option parameters
      * @throws {DuplicateReleaseError} if the release tag already exists
      * @throws {GitHubAPIError} on other API errors
      */
-    createRelease: (release: Release, options?: {
-        draft?: boolean | undefined;
-    } | undefined) => Promise<GitHubRelease>;
+    createRelease: (release: Release, options?: ReleaseOptions | undefined) => Promise<GitHubRelease>;
     /**
      * Makes a comment on a issue/pull request.
      *

package/build/src/github.js

@@ -293,7 +293,7 @@ class GitHub {
          * Create a GitHub release
          *
          * @param {Release} release Release parameters
-         * @param {boolean} draft Whether or not to create the release as a draft
+         * @param {ReleaseOptions} options Release option parameters
          * @throws {DuplicateReleaseError} if the release tag already exists
          * @throws {GitHubAPIError} on other API errors
          */
@@ -306,6 +306,7 @@ class GitHub {
                 body: release.notes,
                 sha: release.sha,
                 draft: !!options.draft,
+                prerelease: !!options.prerelease,
             });
             return {
                 name: resp.data.name || undefined,
@@ -651,39 +652,39 @@ class GitHub {
         logger_1.logger.debug(`Fetching ${states} pull requests on branch ${targetBranch} with cursor ${cursor}`);
         const response = await this.graphqlRequest({
             query: `query mergedPullRequests($owner: String!, $repo: String!, $num: Int!, $maxFilesChanged: Int, $targetBranch: String!, $states: [PullRequestState!], $cursor: String) {
-          repository(owner: $owner, name: $repo) {
-            pullRequests(first: $num, after: $cursor, baseRefName: $targetBranch, states: $states, orderBy: {field: CREATED_AT, direction: DESC}) {
-              nodes {
-                number
-                title
-                baseRefName
-                headRefName
-                labels(first: 10) {
-                  nodes {
-                    name
-                  }
+        repository(owner: $owner, name: $repo) {
+          pullRequests(first: $num, after: $cursor, baseRefName: $targetBranch, states: $states, orderBy: {field: CREATED_AT, direction: DESC}) {
+            nodes {
+              number
+              title
+              baseRefName
+              headRefName
+              labels(first: 10) {
+                nodes {
+                  name
                 }
-                body
-                mergeCommit {
-                  oid
+              }
+              body
+              mergeCommit {
+                oid
+              }
+              files(first: $maxFilesChanged) {
+                nodes {
+                  path
                 }
-                files(first: $maxFilesChanged) {
-                  nodes {
-                    path
-                  }
-                  pageInfo {
-                    endCursor
-                    hasNextPage
-                  }
+                pageInfo {
+                  endCursor
+                  hasNextPage
                 }
               }
-              pageInfo {
-                endCursor
-                hasNextPage
-              }
+            }
+            pageInfo {
+              endCursor
+              hasNextPage
             }
           }
-        }`,
+        }
+      }`,
             cursor,
             owner: this.repository.owner,
             repo: this.repository.repo,

package/build/src/manifest.d.ts

@@ -16,6 +16,7 @@ export interface ReleaserConfig {
     releaseAs?: string;
     skipGithubRelease?: boolean;
     draft?: boolean;
+    prerelease?: boolean;
     draftPullRequest?: boolean;
     component?: string;
     packageName?: string;
@@ -34,8 +35,9 @@ export interface CandidateReleasePullRequest {
 }
 export interface CandidateRelease extends Release {
     pullRequest: PullRequest;
-    draft?: boolean;
     path: string;
+    draft?: boolean;
+    prerelease?: boolean;
 }
 interface ReleaserConfigJson {
     'release-type'?: ReleaseType;
@@ -45,6 +47,7 @@ interface ReleaserConfigJson {
     'release-as'?: string;
     'skip-github-release'?: boolean;
     draft?: boolean;
+    prerelease?: boolean;
     'draft-pull-request'?: boolean;
     label?: string;
     'release-label'?: string;
@@ -66,6 +69,7 @@ export interface ManifestOptions {
     labels?: string[];
     releaseLabels?: string[];
     draft?: boolean;
+    prerelease?: boolean;
     draftPullRequest?: boolean;
 }
 interface ReleaserPackageConfig extends ReleaserConfigJson {
@@ -116,6 +120,7 @@ export declare class Manifest {
     private bootstrapSha?;
     private lastReleaseSha?;
     private draft?;
+    private prerelease?;
     private draftPullRequest?;
     /**
      * Create a Manifest from explicit config in code. This assumes that the

package/build/src/manifest.js

@@ -439,6 +439,9 @@ class Manifest {
                         path,
                         pullRequest,
                         draft: (_a = config.draft) !== null && _a !== void 0 ? _a : this.draft,
+                        prerelease: config.prerelease &&
+                            (!!release.tag.version.preRelease ||
+                                release.tag.version.major === 0),
                     });
                 }
             }
@@ -488,6 +491,7 @@ class Manifest {
     async createRelease(release) {
         const githubRelease = await this.github.createRelease(release, {
             draft: release.draft,
+            prerelease: release.prerelease,
         });
         // comment on pull request
         const comment = `:robot: Release is at ${githubRelease.url} :sunflower:`;
@@ -553,6 +557,7 @@ function extractReleaserConfig(config) {
         releaseAs: config['release-as'],
         skipGithubRelease: config['skip-github-release'],
         draft: config.draft,
+        prerelease: config.prerelease,
         draftPullRequest: config['draft-pull-request'],
         component: config['component'],
         packageName: config['package-name'],
@@ -696,7 +701,7 @@ async function latestReleaseVersion(github, targetBranch, prefix, pullRequestTit
     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;
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p;
     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,
@@ -706,10 +711,11 @@ function mergeReleaserConfig(defaultConfig, pathConfig) {
         releaseAs: (_g = pathConfig.releaseAs) !== null && _g !== void 0 ? _g : defaultConfig.releaseAs,
         skipGithubRelease: (_h = pathConfig.skipGithubRelease) !== null && _h !== void 0 ? _h : defaultConfig.skipGithubRelease,
         draft: (_j = pathConfig.draft) !== null && _j !== void 0 ? _j : defaultConfig.draft,
-        component: (_k = pathConfig.component) !== null && _k !== void 0 ? _k : defaultConfig.component,
-        packageName: (_l = pathConfig.packageName) !== null && _l !== void 0 ? _l : defaultConfig.packageName,
-        versionFile: (_m = pathConfig.versionFile) !== null && _m !== void 0 ? _m : defaultConfig.versionFile,
-        extraFiles: (_o = pathConfig.extraFiles) !== null && _o !== void 0 ? _o : defaultConfig.extraFiles,
+        prerelease: (_k = pathConfig.prerelease) !== null && _k !== void 0 ? _k : defaultConfig.prerelease,
+        component: (_l = pathConfig.component) !== null && _l !== void 0 ? _l : defaultConfig.component,
+        packageName: (_m = pathConfig.packageName) !== null && _m !== void 0 ? _m : defaultConfig.packageName,
+        versionFile: (_o = pathConfig.versionFile) !== null && _o !== void 0 ? _o : defaultConfig.versionFile,
+        extraFiles: (_p = pathConfig.extraFiles) !== null && _p !== void 0 ? _p : defaultConfig.extraFiles,
     };
 }
 /**

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

@@ -5,6 +5,9 @@ import { GitHubFileContents } from '../github';
 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 {
     private versionsContent?;
     private snapshotVersioning;
@@ -14,7 +17,8 @@ export declare class JavaYoshi extends BaseStrategy {
     private needsSnapshot;
     protected buildVersionsMap(): Promise<VersionsMap>;
     protected getVersionsContent(): Promise<GitHubFileContents>;
-    protected buildUpdates(options: BuildUpdatesOptions): Promise<Update[]>;
+    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

@@ -78,26 +78,24 @@ class JavaYoshi extends base_1.BaseStrategy {
         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: '### Updating meta-information for bleeding-edge SNAPSHOT release.',
+                notes,
             },
         ]);
+        const updates = await this.buildUpdates({
+            newVersion,
+            versionsMap,
+            changelogEntry: notes,
+            isSnapshot: true,
+        });
         return {
             title: pullRequestTitle,
             body: pullRequestBody,
-            updates: [
-                {
-                    path: this.addPath('versions.txt'),
-                    createIfMissing: false,
-                    updater: new versions_manifest_1.VersionsManifest({
-                        version: newVersion,
-                        versionsMap,
-                    }),
-                },
-            ],
+            updates,
             labels: [],
             headRefName: branchName.toString(),
             version: newVersion,
@@ -149,6 +147,7 @@ class JavaYoshi extends base_1.BaseStrategy {
                 updater: new java_update_1.JavaUpdate({
                     version,
                     versionsMap,
+                    isSnapshot: options.isSnapshot,
                 }),
             });
         });
@@ -160,6 +159,7 @@ class JavaYoshi extends base_1.BaseStrategy {
                 updater: new java_update_1.JavaUpdate({
                     version,
                     versionsMap,
+                    isSnapshot: options.isSnapshot,
                 }),
             });
         });
@@ -171,6 +171,7 @@ class JavaYoshi extends base_1.BaseStrategy {
                 updater: new java_update_1.JavaUpdate({
                     version,
                     versionsMap,
+                    isSnapshot: options.isSnapshot,
                 }),
             });
         });
@@ -181,17 +182,20 @@ class JavaYoshi extends base_1.BaseStrategy {
                 updater: new java_update_1.JavaUpdate({
                     version,
                     versionsMap,
+                    isSnapshot: options.isSnapshot,
                 }),
             });
         });
-        updates.push({
-            path: this.addPath(this.changelogPath),
-            createIfMissing: true,
-            updater: new changelog_1.Changelog({
-                version,
-                changelogEntry: options.changelogEntry,
-            }),
-        });
+        if (!options.isSnapshot) {
+            updates.push({
+                path: this.addPath(this.changelogPath),
+                createIfMissing: true,
+                updater: new changelog_1.Changelog({
+                    version,
+                    changelogEntry: options.changelogEntry,
+                }),
+            });
+        }
         return updates;
     }
     async updateVersionsMap(versionsMap, conventionalCommits) {

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

@@ -1,10 +1,15 @@
-import { DefaultUpdater } from '../default';
+import { DefaultUpdater, UpdateOptions } from '../default';
+interface JavaUpdateOptions extends UpdateOptions {
+    isSnapshot?: boolean;
+}
 /**
  * Updates a file annotated with region markers. These region markers are
  * either denoted inline with `{x-version-update:<component-name>:current|released}`
  * or with a `{x-version-update-start:<component-name>}` and `{x-version-update-end}`.
  */
 export declare class JavaUpdate extends DefaultUpdater {
+    isSnapshot: boolean;
+    constructor(options: JavaUpdateOptions);
     /**
      * Given initial file contents, return updated contents.
      * @param {string} content The initial content
@@ -12,3 +17,4 @@ export declare class JavaUpdate extends DefaultUpdater {
      */
     updateContent(content: string): string;
 }
+export {};

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

@@ -26,6 +26,10 @@ const VERSION_REGEX = /\d+\.\d+\.\d+(-\w+(\.\d+)?)?(-SNAPSHOT)?/;
  * or with a `{x-version-update-start:<component-name>}` and `{x-version-update-end}`.
  */
 class JavaUpdate extends default_1.DefaultUpdater {
+    constructor(options) {
+        super(options);
+        this.isSnapshot = !!options.isSnapshot;
+    }
     /**
      * Given initial file contents, return updated contents.
      * @param {string} content The initial content
@@ -40,7 +44,7 @@ class JavaUpdate extends default_1.DefaultUpdater {
         let blockPackageName = null;
         content.split(/\r?\n/).forEach(line => {
             let match = line.match(INLINE_UPDATE_REGEX);
-            if (match) {
+            if (match && (!this.isSnapshot || match[2] === 'current')) {
                 const newVersion = this.versionsMap.get(match[1]);
                 if (newVersion) {
                     newLines.push(line.replace(VERSION_REGEX, newVersion.toString()));
@@ -63,7 +67,7 @@ class JavaUpdate extends default_1.DefaultUpdater {
             }
             else {
                 match = line.match(BLOCK_START_REGEX);
-                if (match) {
+                if (match && (!this.isSnapshot || match[2] === 'current')) {
                     blockPackageName = match[1];
                 }
                 newLines.push(line);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "release-please",
-  "version": "13.1.1",
+  "version": "13.2.0",
   "description": "generate release PRs based on the conventionalcommits.org spec",
   "main": "./build/src/index.js",
   "bin": "./build/src/bin/release-please.js",
@@ -50,7 +50,7 @@
     "c8": "^7.0.0",
     "chai": "^4.2.0",
     "cross-env": "^7.0.0",
-    "gts": "^2.0.0",
+    "gts": "^3.0.0",
     "mocha": "^8.0.0",
     "nock": "^13.0.0",
     "sinon": "12.0.1",