fix: reimplement draft releases (#1111)

__snapshots__/cli.js

@@ -49,34 +49,34 @@ release-please manifest-pr
 create a release-PR using a manifest file
 
 Options:
-  --help            Show help                                          [boolean]
-  --version         Show version number                                [boolean]
-  --debug           print verbose errors (use only for local debugging).
-                                                      [boolean] [default: false]
-  --trace           print extra verbose errors (use only for local debugging).
+  --help                Show help                                      [boolean]
+  --version             Show version number                            [boolean]
+  --debug               print verbose errors (use only for local debugging).
                                                       [boolean] [default: false]
-  --token           GitHub token with repo write permissions
-  --api-url         URL to use when making API requests
+  --trace               print extra verbose errors (use only for local
+                        debugging).                   [boolean] [default: false]
+  --token               GitHub token with repo write permissions
+  --api-url             URL to use when making API requests
                                     [string] [default: "https://api.github.com"]
-  --graphql-url     URL to use when making GraphQL requests
+  --graphql-url         URL to use when making GraphQL requests
                                     [string] [default: "https://api.github.com"]
-  --default-branch  The branch to open release PRs against and tag releases on
-                              [deprecated: use --target-branch instead] [string]
-  --target-branch   The branch to open release PRs against and tag releases on
-                                                                        [string]
-  --repo-url        GitHub URL to generate release for                [required]
-  --dry-run         Prepare but do not take action    [boolean] [default: false]
-  --label           comma-separated list of labels to add to from release PR
+  --default-branch      The branch to open release PRs against and tag releases
+                        on    [deprecated: use --target-branch instead] [string]
+  --target-branch       The branch to open release PRs against and tag releases
+                        on                                              [string]
+  --repo-url            GitHub URL to generate release for            [required]
+  --dry-run             Prepare but do not take action[boolean] [default: false]
+  --label               comma-separated list of labels to add to from release PR
                                                [default: "autorelease: pending"]
-  --fork            should the PR be created from a fork
+  --fork                should the PR be created from a fork
                                                       [boolean] [default: false]
-  --draft           mark pull request as a draft      [boolean] [default: false]
-  --signoff         Add Signed-off-by line at the end of the commit log message
-                    using the user and email provided. (format "Name
-                    <email@example.com>").                              [string]
-  --config-file     where can the config file be found in the project?
+  --draft-pull-request  mark pull request as a draft  [boolean] [default: false]
+  --signoff             Add Signed-off-by line at the end of the commit log
+                        message using the user and email provided. (format "Name
+                        <email@example.com>").                          [string]
+  --config-file         where can the config file be found in the project?
                                          [default: "release-please-config.json"]
-  --manifest-file   where can the manifest file be found in the project?
+  --manifest-file       where can the manifest file be found in the project?
                                       [default: ".release-please-manifest.json"]
 `
 
@@ -176,7 +176,7 @@ Options:
                                                [default: "autorelease: pending"]
   --fork                            should the PR be created from a fork
                                                       [boolean] [default: false]
-  --draft                           mark pull request as a draft
+  --draft-pull-request              mark pull request as a draft
                                                       [boolean] [default: false]
   --signoff                         Add Signed-off-by line at the end of the
                                     commit log message using the user and email

src/bin/release-please.ts

@@ -84,7 +84,7 @@ interface ReleaseArgs {
 }
 
 interface PullRequestArgs {
-  draft?: boolean;
+  draftPullRequest?: boolean;
   label?: string;
   signoff?: string;
 }
@@ -129,7 +129,8 @@ interface BootstrapArgs
     ManifestConfigArgs,
     VersioningArgs,
     PullRequestArgs,
-    PullRequestStrategyArgs {
+    PullRequestStrategyArgs,
+    ReleaseArgs {
   initialVersion?: string;
 }
 
@@ -207,7 +208,7 @@ function pullRequestOptions(yargs: yargs.Argv): yargs.Argv {
       type: 'boolean',
       default: false,
     })
-    .option('draft', {
+    .option('draft-pull-request', {
       describe: 'mark pull request as a draft',
       type: 'boolean',
       default: false,
@@ -374,7 +375,7 @@ const createReleasePullRequestCommand: yargs.CommandModule<
           releaseType: argv.releaseType,
           component: argv.component,
           packageName: argv.packageName,
-          draft: argv.draft,
+          draftPullRequest: argv.draftPullRequest,
           bumpMinorPreMajor: argv.bumpMinorPreMajor,
           bumpPatchForMinorPreMajor: argv.bumpPatchForMinorPreMajor,
           changelogPath: argv.changelogPath,
@@ -565,7 +566,9 @@ const bootstrapCommand: yargs.CommandModule<{}, BootstrapArgs> = {
   command: 'bootstrap',
   describe: 'configure release manifest',
   builder(yargs) {
-    return manifestOptions(pullRequestStrategyOptions(gitHubOptions(yargs)))
+    return manifestOptions(
+      releaseOptions(pullRequestStrategyOptions(gitHubOptions(yargs)))
+    )
       .option('initial-version', {
         description: 'current version',
       })
@@ -591,6 +594,7 @@ const bootstrapCommand: yargs.CommandModule<{}, BootstrapArgs> = {
       component: argv.component,
       packageName: argv.packageName,
       draft: argv.draft,
+      draftPullRequest: argv.draftPullRequest,
       bumpMinorPreMajor: argv.bumpMinorPreMajor,
       bumpPatchForMinorPreMajor: argv.bumpPatchForMinorPreMajor,
       changelogPath: argv.changelogPath,
@@ -648,7 +652,7 @@ interface HandleError {
 }
 
 function extractManifestOptions(
-  argv: (GitHubArgs & PullRequestArgs) | ReleaseArgs
+  argv: GitHubArgs & (PullRequestArgs | ReleaseArgs)
 ): ManifestOptions {
   const manifestOptions: ManifestOptions = {};
   if ('fork' in argv && argv.fork !== undefined) {
@@ -666,6 +670,9 @@ function extractManifestOptions(
   if ('draft' in argv && argv.draft !== undefined) {
     manifestOptions.draft = argv.draft;
   }
+  if ('draftPullRequest' in argv && argv.draftPullRequest !== undefined) {
+    manifestOptions.draftPullRequest = argv.draftPullRequest;
+  }
   return manifestOptions;
 }
 

src/github.ts

@@ -108,6 +108,7 @@ interface GraphQLRelease {
   };
   url: string;
   description: string;
+  isDraft: boolean;
 }
 
 interface CommitHistory {
@@ -140,6 +141,7 @@ export interface GitHubRelease {
   sha: string;
   notes?: string;
   url: string;
+  draft?: boolean;
 }
 
 export class GitHub {
@@ -608,6 +610,7 @@ export class GitHub {
               }
               url
               description
+              isDraft
             }
             pageInfo {
               endCursor
@@ -641,41 +644,12 @@ export class GitHub {
             sha: release.tagCommit.oid,
             notes: release.description,
             url: release.url,
+            draft: release.isDraft,
           };
         }),
     };
   }
 
-  /**
-   * Return a list of tags. The list is not guaranteed to be sorted.
-   *
-   * @param {number} page - Page of results. Defaults to 1.
-   * @param {number} perPage - Number of results per page. Defaults to 100.
-   * @returns {GitHubRelease[]} - List of tags
-   * @throws {GitHubAPIError} on an API error
-   */
-  private listReleases = wrapAsync(
-    async (page = 1, perPage = 100): Promise<GitHubRelease[]> => {
-      logger.debug(`Fetching releases page ${page}`);
-      const releases = await this.octokit.repos.listReleases({
-        owner: this.repository.owner,
-        repo: this.repository.repo,
-        page,
-        per_page: perPage,
-      });
-
-      return releases.data.map(release => {
-        return {
-          name: release.name || undefined,
-          tagName: release.tag_name,
-          sha: release.target_commitish,
-          notes: release.body_text,
-          url: release.html_url,
-        };
-      });
-    }
-  );
-
   /**
    * Fetch the contents of a file from the configured branch
    *
@@ -1165,20 +1139,25 @@ export class GitHub {
    * @throws {GitHubAPIError} on other API errors
    */
   createRelease = wrapAsync(
-    async (release: Release): Promise<GitHubRelease> => {
+    async (
+      release: Release,
+      options: {draft?: boolean} = {}
+    ): Promise<GitHubRelease> => {
       const resp = await this.octokit.repos.createRelease({
         owner: this.repository.owner,
         repo: this.repository.repo,
         tag_name: release.tag.toString(),
         body: release.notes,
         sha: release.sha,
+        draft: !!options.draft,
       });
       return {
         name: resp.data.name || undefined,
         tagName: resp.data.tag_name,
         sha: resp.data.target_commitish,
         notes: resp.data.body_text,
         url: resp.data.html_url,
+        draft: resp.data.draft,
       };
     },
     e => {

src/manifest.ts

@@ -53,6 +53,7 @@ export interface ReleaserConfig {
   releaseAs?: string;
   skipGithubRelease?: boolean;
   draft?: boolean;
+  draftPullRequest?: boolean;
   component?: string;
   packageName?: string;
 
@@ -70,6 +71,7 @@ export interface CandidateReleasePullRequest {
 
 export interface CandidateRelease extends Release {
   pullRequest: PullRequest;
+  draft?: boolean;
 }
 
 interface ReleaserConfigJson {
@@ -80,6 +82,7 @@ interface ReleaserConfigJson {
   'release-as'?: string;
   'skip-github-release'?: boolean;
   draft?: boolean;
+  'draft-pull-request'?: boolean;
   label?: string;
   'release-label'?: string;
 
@@ -101,7 +104,7 @@ export interface ManifestOptions {
   labels?: string[];
   releaseLabels?: string[];
   draft?: boolean;
-  releaseDraft?: boolean;
+  draftPullRequest?: boolean;
 }
 
 interface ReleaserPackageConfig extends ReleaserConfigJson {
@@ -154,6 +157,8 @@ export class Manifest {
   private manifestPath: string;
   private bootstrapSha?: string;
   private lastReleaseSha?: string;
+  private draft?: boolean;
+  private draftPullRequest?: boolean;
 
   /**
    * Create a Manifest from explicit config in code. This assumes that the
@@ -203,6 +208,8 @@ export class Manifest {
     this.labels = manifestOptions?.labels || DEFAULT_LABELS;
     this.bootstrapSha = manifestOptions?.bootstrapSha;
     this.lastReleaseSha = manifestOptions?.lastReleaseSha;
+    this.draft = manifestOptions?.draft;
+    this.draftPullRequest = manifestOptions?.draftPullRequest;
   }
 
   /**
@@ -457,7 +464,7 @@ export class Manifest {
       const releasePullRequest = await strategy.buildReleasePullRequest(
         pathCommits,
         latestRelease,
-        config.draft,
+        config.draftPullRequest ?? this.draftPullRequest,
         this.labels
       );
       if (releasePullRequest) {
@@ -663,6 +670,7 @@ export class Manifest {
           releases.push({
             ...release,
             pullRequest,
+            draft: config.draft ?? this.draft,
           });
         }
       }
@@ -726,7 +734,9 @@ export class Manifest {
   private async createRelease(
     release: CandidateRelease
   ): Promise<GitHubRelease> {
-    const githubRelease = await this.github.createRelease(release);
+    const githubRelease = await this.github.createRelease(release, {
+      draft: release.draft,
+    });
 
     // comment on pull request
     const comment = `:robot: Release is at ${githubRelease.url} :sunflower:`;
@@ -791,6 +801,7 @@ function extractReleaserConfig(config: ReleaserPackageConfig): ReleaserConfig {
     releaseAs: config['release-as'],
     skipGithubRelease: config['skip-github-release'],
     draft: config.draft,
+    draftPullRequest: config['draft-pull-request'],
     component: config['component'],
     packageName: config['package-name'],
     versionFile: config['version-file'],

test/cli.ts

@@ -782,9 +782,9 @@ describe('CLI', () => {
         sinon.assert.calledOnce(createPullRequestsStub);
       });
 
-      it('handles --draft', async () => {
+      it('handles --draft-pull-request', async () => {
         await parser.parseAsync(
-          'release-pr --repo-url=googleapis/release-please-cli --release-type=java-yoshi --draft'
+          'release-pr --repo-url=googleapis/release-please-cli --release-type=java-yoshi --draft-pull-request'
         );
 
         sinon.assert.calledOnceWithExactly(gitHubCreateStub, {
@@ -796,8 +796,8 @@ describe('CLI', () => {
           fromConfigStub,
           fakeGitHub,
           'main',
-          sinon.match({releaseType: 'java-yoshi'}),
-          sinon.match({draft: true}),
+          sinon.match({releaseType: 'java-yoshi', draftPullRequest: true}),
+          sinon.match.any,
           undefined
         );
         sinon.assert.calledOnce(createPullRequestsStub);
@@ -1115,7 +1115,7 @@ describe('CLI', () => {
           fakeGitHub,
           'main',
           sinon.match({releaseType: 'java-yoshi', draft: true}),
-          sinon.match({draft: true}),
+          sinon.match.any,
           undefined
         );
         sinon.assert.calledOnce(createReleasesStub);