release-please 13.0.0-candidate.0 → 13.0.0-candidate.1

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

@@ -37,8 +37,13 @@ interface ManifestConfigArgs {
     packageName?: string;
     releaseType?: ReleaseType;
 }
-interface PullRequestArgs {
+interface ReleaseArgs {
     draft?: boolean;
+    releaseLabel?: string;
+    label?: string;
+}
+interface PullRequestArgs {
+    draftPullRequest?: boolean;
     label?: string;
     signoff?: string;
 }
@@ -52,7 +57,7 @@ interface PullRequestStrategyArgs {
     pullRequestTitlePattern?: string;
     extraFiles?: string[];
 }
-interface BootstrapArgs extends GitHubArgs, ManifestArgs, ManifestConfigArgs, VersioningArgs, PullRequestArgs, PullRequestStrategyArgs {
+interface BootstrapArgs extends GitHubArgs, ManifestArgs, ManifestConfigArgs, VersioningArgs, PullRequestArgs, PullRequestStrategyArgs, ReleaseArgs {
     initialVersion?: string;
 }
 export declare const parser: yargs.Argv<BootstrapArgs & {

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

@@ -98,7 +98,7 @@ function pullRequestOptions(yargs) {
         type: 'boolean',
         default: false,
     })
-        .option('draft', {
+        .option('draft-pull-request', {
         describe: 'mark pull request as a draft',
         type: 'boolean',
         default: false,
@@ -239,7 +239,7 @@ const createReleasePullRequestCommand = {
                 releaseType: argv.releaseType,
                 component: argv.component,
                 packageName: argv.packageName,
-                draft: argv.draft,
+                draftPullRequest: argv.draftPullRequest,
                 bumpMinorPreMajor: argv.bumpMinorPreMajor,
                 bumpPatchForMinorPreMajor: argv.bumpPatchForMinorPreMajor,
                 changelogPath: argv.changelogPath,
@@ -378,7 +378,7 @@ const bootstrapCommand = {
     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',
         })
@@ -397,6 +397,7 @@ const bootstrapCommand = {
             component: argv.component,
             packageName: argv.packageName,
             draft: argv.draft,
+            draftPullRequest: argv.draftPullRequest,
             bumpMinorPreMajor: argv.bumpMinorPreMajor,
             bumpPatchForMinorPreMajor: argv.bumpPatchForMinorPreMajor,
             changelogPath: argv.changelogPath,
@@ -462,6 +463,9 @@ function extractManifestOptions(argv) {
     if ('draft' in argv && argv.draft !== undefined) {
         manifestOptions.draft = argv.draft;
     }
+    if ('draftPullRequest' in argv && argv.draftPullRequest !== undefined) {
+        manifestOptions.draftPullRequest = argv.draftPullRequest;
+    }
     return manifestOptions;
 }
 // The errors returned by octokit currently contain the

package/build/src/github.d.ts

@@ -42,6 +42,7 @@ export interface GitHubRelease {
     sha: string;
     notes?: string;
     url: string;
+    draft?: boolean;
 }
 export declare class GitHub {
     readonly repository: Repository;
@@ -97,6 +98,14 @@ export declare class GitHub {
      */
     mergeCommitIterator(targetBranch: string, maxResults?: number): AsyncGenerator<Commit, void, unknown>;
     private mergeCommitsGraphQL;
+    /**
+     * Get the list of file paths modified in a given commit.
+     *
+     * @param {string} sha The commit SHA
+     * @returns {string[]} File paths
+     * @throws {GitHubAPIError} on an API error
+     */
+    getCommitFiles: (sha: string) => Promise<string[]>;
     private graphqlRequest;
     /**
      * Iterate through merged pull requests with a max number of results scanned.
@@ -129,15 +138,6 @@ export declare class GitHub {
      */
     releaseIterator(maxResults?: number): AsyncGenerator<GitHubRelease, void, unknown>;
     private releaseGraphQL;
-    /**
-     * 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;
     /**
      * Fetch the contents of a file from the configured branch
      *
@@ -276,7 +276,9 @@ export declare class GitHub {
      * @throws {DuplicateReleaseError} if the release tag already exists
      * @throws {GitHubAPIError} on other API errors
      */
-    createRelease: (release: Release) => Promise<GitHubRelease>;
+    createRelease: (release: Release, options?: {
+        draft?: boolean | undefined;
+    } | undefined) => Promise<GitHubRelease>;
     /**
      * Makes a comment on a issue/pull request.
      *

package/build/src/github.js

@@ -28,6 +28,23 @@ const manifest_1 = require("./manifest");
 const signoff_commit_message_1 = require("./util/signoff-commit-message");
 class GitHub {
     constructor(options) {
+        /**
+         * Get the list of file paths modified in a given commit.
+         *
+         * @param {string} sha The commit SHA
+         * @returns {string[]} File paths
+         * @throws {GitHubAPIError} on an API error
+         */
+        this.getCommitFiles = wrapAsync(async (sha) => {
+            logger_1.logger.debug(`Backfilling file list for commit: ${sha}`);
+            const resp = await this.octokit.repos.getCommit({
+                owner: this.repository.owner,
+                repo: this.repository.repo,
+                ref: sha,
+            });
+            const files = resp.data.files || [];
+            return files.map(file => file.filename).filter(filename => !!filename);
+        });
         this.graphqlRequest = wrapAsync(async (opts, maxRetries = 1) => {
             while (maxRetries >= 0) {
                 try {
@@ -41,32 +58,6 @@ class GitHub {
                 maxRetries -= 1;
             }
         });
-        /**
-         * 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
-         */
-        this.listReleases = wrapAsync(async (page = 1, perPage = 100) => {
-            logger_1.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 with the Contents API
          *
@@ -306,13 +297,14 @@ class GitHub {
          * @throws {DuplicateReleaseError} if the release tag already exists
          * @throws {GitHubAPIError} on other API errors
          */
-        this.createRelease = wrapAsync(async (release) => {
+        this.createRelease = wrapAsync(async (release, options = {}) => {
             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,
@@ -320,6 +312,7 @@ class GitHub {
                 sha: resp.data.target_commitish,
                 notes: resp.data.body_text,
                 url: resp.data.html_url,
+                draft: resp.data.draft,
             };
         }, e => {
             if (e instanceof request_error_1.RequestError) {
@@ -568,38 +561,44 @@ class GitHub {
         }
         const history = response.repository.ref.target.history;
         const commits = (history.nodes || []);
+        const commitData = [];
+        for (const graphCommit of commits) {
+            const commit = {
+                sha: graphCommit.sha,
+                message: graphCommit.message,
+                files: [],
+            };
+            const pullRequest = graphCommit.associatedPullRequests.nodes.find(pr => {
+                return pr.mergeCommit && pr.mergeCommit.oid === graphCommit.sha;
+            });
+            if (pullRequest) {
+                const files = pullRequest.files.nodes.map(node => node.path);
+                commit.pullRequest = {
+                    sha: commit.sha,
+                    number: pullRequest.number,
+                    baseBranchName: pullRequest.baseRefName,
+                    headBranchName: pullRequest.headRefName,
+                    title: pullRequest.title,
+                    body: pullRequest.body,
+                    labels: pullRequest.labels.nodes.map(node => node.name),
+                    files,
+                };
+                // We cannot directly fetch files on commits via graphql, only provide file
+                // information for commits with associated pull requests
+                commit.files = files;
+            }
+            else {
+                // In this case, there is no squashed merge commit. This could be a simple
+                // merge commit, a rebase merge commit, or a direct commit to the branch.
+                // Fallback to fetching the list of commits from the REST API. In the future
+                // we can perhaps lazy load these.
+                commit.files = await this.getCommitFiles(graphCommit.sha);
+            }
+            commitData.push(commit);
+        }
         return {
             pageInfo: history.pageInfo,
-            data: commits.map(graphCommit => {
-                const commit = {
-                    sha: graphCommit.sha,
-                    message: graphCommit.message,
-                    files: [],
-                };
-                const pullRequest = graphCommit.associatedPullRequests.nodes.find(pr => {
-                    return pr.mergeCommit && pr.mergeCommit.oid === graphCommit.sha;
-                });
-                if (pullRequest) {
-                    const files = pullRequest.files.nodes.map(node => node.path);
-                    commit.pullRequest = {
-                        sha: commit.sha,
-                        number: pullRequest.number,
-                        baseBranchName: pullRequest.baseRefName,
-                        headBranchName: pullRequest.headRefName,
-                        title: pullRequest.title,
-                        body: pullRequest.body,
-                        labels: pullRequest.labels.nodes.map(node => node.name),
-                        files,
-                    };
-                    // We cannot directly fetch files on commits via graphql, only provide file
-                    // information for commits with associated pull requests
-                    commit.files = files;
-                }
-                else {
-                    logger_1.logger.warn(`No merged pull request for commit: ${graphCommit.sha} - files unavailable`);
-                }
-                return commit;
-            }),
+            data: commitData,
         };
     }
     /**
@@ -750,6 +749,7 @@ class GitHub {
               }
               url
               description
+              isDraft
             }
             pageInfo {
               endCursor
@@ -783,6 +783,7 @@ class GitHub {
                     sha: release.tagCommit.oid,
                     notes: release.description,
                     url: release.url,
+                    draft: release.isDraft,
                 };
             }),
         };

package/build/src/manifest.d.ts

@@ -18,6 +18,7 @@ export interface ReleaserConfig {
     releaseAs?: string;
     skipGithubRelease?: boolean;
     draft?: boolean;
+    draftPullRequest?: boolean;
     component?: string;
     packageName?: string;
     versionFile?: string;
@@ -30,6 +31,7 @@ export interface CandidateReleasePullRequest {
 }
 export interface CandidateRelease extends Release {
     pullRequest: PullRequest;
+    draft?: boolean;
 }
 interface ReleaserConfigJson {
     'release-type'?: ReleaseType;
@@ -39,6 +41,7 @@ interface ReleaserConfigJson {
     'release-as'?: string;
     'skip-github-release'?: boolean;
     draft?: boolean;
+    'draft-pull-request'?: boolean;
     label?: string;
     'release-label'?: string;
     'version-file'?: string;
@@ -56,7 +59,7 @@ export interface ManifestOptions {
     labels?: string[];
     releaseLabels?: string[];
     draft?: boolean;
-    releaseDraft?: boolean;
+    draftPullRequest?: boolean;
 }
 interface ReleaserPackageConfig extends ReleaserConfigJson {
     'package-name'?: string;
@@ -98,6 +101,8 @@ export declare class Manifest {
     private manifestPath;
     private bootstrapSha?;
     private lastReleaseSha?;
+    private draft?;
+    private draftPullRequest?;
     /**
      * Create a Manifest from explicit config in code. This assumes that the
      * repository has a single component at the root path.

package/build/src/manifest.js

@@ -74,6 +74,8 @@ class Manifest {
         this.labels = (manifestOptions === null || manifestOptions === void 0 ? void 0 : manifestOptions.labels) || DEFAULT_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;
+        this.draftPullRequest = manifestOptions === null || manifestOptions === void 0 ? void 0 : manifestOptions.draftPullRequest;
     }
     /**
      * Create a Manifest from config files in the repository.
@@ -140,6 +142,7 @@ class Manifest {
      * @returns {ReleasePullRequest[]} The candidate pull requests to open or update.
      */
     async buildPullRequests() {
+        var _a;
         logger_1.logger.info('Building pull requests');
         const pathsByComponent = await this.getPathsByComponent();
         const strategiesByPath = await this.getStrategiesByPath();
@@ -258,7 +261,7 @@ class Manifest {
             }
             const strategy = strategiesByPath[path];
             const latestRelease = releasesByPath[path];
-            const releasePullRequest = await strategy.buildReleasePullRequest(pathCommits, latestRelease, config.draft, this.labels);
+            const releasePullRequest = await strategy.buildReleasePullRequest(pathCommits, latestRelease, (_a = config.draftPullRequest) !== null && _a !== void 0 ? _a : this.draftPullRequest, this.labels);
             if (releasePullRequest) {
                 if (releasePullRequest.version) {
                     const versionsMap = new Map();
@@ -376,6 +379,7 @@ class Manifest {
      * @returns {CandidateRelease[]} List of release candidates
      */
     async buildReleases() {
+        var _a;
         logger_1.logger.info('Building releases');
         const strategiesByPath = await this.getStrategiesByPath();
         // Find merged release pull requests
@@ -411,6 +415,7 @@ class Manifest {
                     releases.push({
                         ...release,
                         pullRequest,
+                        draft: (_a = config.draft) !== null && _a !== void 0 ? _a : this.draft,
                     });
                 }
             }
@@ -458,7 +463,9 @@ class Manifest {
         return githubReleases;
     }
     async createRelease(release) {
-        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:`;
         await this.github.commentOnIssue(comment, release.pullRequest.number);
@@ -493,7 +500,6 @@ class Manifest {
                     logger_1.logger.warn(`Multiple paths for ${component}: ${this._pathsByComponent[component]}, ${path}`);
                 }
                 this._pathsByComponent[component] = path;
-                logger_1.logger.info(this._pathsByComponent);
             }
         }
         return this._pathsByComponent;
@@ -517,6 +523,7 @@ function extractReleaserConfig(config) {
         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'],

package/build/src/versioning-strategy.js

@@ -26,7 +26,7 @@ class MajorVersionUpdate {
 exports.MajorVersionUpdate = MajorVersionUpdate;
 class MinorVersionUpdate {
     constructor() {
-        this.name = 'major';
+        this.name = 'minor';
     }
     bump(version) {
         return new version_1.Version(version.major, version.minor + 1, 0, version.preRelease, version.build);
@@ -35,7 +35,7 @@ class MinorVersionUpdate {
 exports.MinorVersionUpdate = MinorVersionUpdate;
 class PatchVersionUpdate {
     constructor() {
-        this.name = 'major';
+        this.name = 'patch';
     }
     bump(version) {
         return new version_1.Version(version.major, version.minor, version.patch + 1, version.preRelease, version.build);

package/package.json

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