build: initial release staging script #13621

devversion · 2018-10-15T19:06:35Z

Creates an initial release staging script with prompts.

@jelbourn This is an initial version. There are still a few things like the changelog that I want to address. But those should be additional PRs. -- For now, I've kept the existing Gulp publish stuff until this is finished completely.

jelbourn · 2018-10-16T01:06:59Z

tools/release/git/executor.ts

+ * on the working directory of the current process is not good because it's not guaranteed
+ * that the working directory is always the target project directory (e.g. w/ bazel run).
+ */
+export class GitCommandExecutor {


Maybe GitClient? "CommandExecutor" makes me think you would pass it full commands to run rather than using API methods directly.

"Executor" also makes me think of something else...

Ugh haha 😅- GitClient sounds better yeah.

jelbourn · 2018-10-16T01:09:59Z

tools/release/git/executor.ts

+
+  /** Returns the currently checked out branch for the current working directory. */
+  getCurrentBranch() {
+    return spawnSync('git', ['symbolic-ref', '--short', 'HEAD'], {cwd: this.projectDir})


git name-rev might be better here (?). Or maybe just shorter ¯\(ツ)/¯

It seems that git name-rev is not returning a short variant of the symbol name.

This is the output: HEAD build/release-automation-script. With symbolic-ref we just get the actual branch name and can read from stdout.

jelbourn · 2018-10-16T01:10:34Z

tools/release/git/executor.ts

+
+  constructor(public projectDir: string) {}
+
+  /** Returns the currently checked out branch for the current working directory. */


nit: prefer "Gets ..." to "Returns ..."

jelbourn · 2018-10-16T01:14:38Z

tools/release/prompt/new-version-prompt.ts

+
+  if (!currentVersion) {
+    console.warn(red(`Cannot parse current project version. This means that we cannot validate ` +
+      `the new ${bold('custom')} version that will be specified.`));


Should we just throw in this case? Why would we ever want to continue if this fails?

jelbourn · 2018-10-16T01:17:11Z

tools/release/version-name/parse-version.ts

+              public minor: number,
+              public patch: number,
+              public suffix?: string,
+              public suffixNumber?: number) {}


How about
suffix -> prereleaseLabel
suffixNumber -> prereleaseNumber

A comment that breaks down the different parts would also be good to include here.

jelbourn · 2018-10-16T01:56:34Z

tools/release/version-name/check-version.ts

+      newVersion.major === previousVersion.major &&
+      newVersion.minor === previousVersion.minor &&
+      newVersion.patch === previousVersion.patch;
+}


These last four cases could be written a bit more concisely like:

export function validateExpectedVersion(newVersion: VersionInfo, previous: VersionInfo, releaseType: ReleaseType): boolean { let expectedVersion; if (releaseType === 'major') { expectedVersion = new VersionInfo(previous.major + 1, 0, 0); } else if (releaseType === 'minor') { expectedVersion = new VersionInfo(previous.major, previous.minor + 1, 0); } else if (releaseType === 'patch') { expectedVersion = new VersionInfo(previous.major, previous.minor, previous.patch + 1); } else if (releaseType === 'stable') { expectedVersion = new VersionInfo(previous.major, previous.minor, previous.patch); } return newVersion.equals(expectedVersion); }

(with the corresponding addition of the equals method on VersionInfo)

This check is gone completely now.

jelbourn · 2018-10-16T01:57:09Z

tools/release/version-name/parse-version.ts

+/** Regular expression that matches version names and the individual version segments. */
+const versionNameRegex = /^(\d+)\.(\d+)\.(\d+)(?:-(alpha|beta|rc)\.(\d)+)?$/;
+
+export class VersionInfo {


Just Version?

Sounds good.

jelbourn · 2018-10-16T01:57:56Z

tools/release/version-name/publish-branch.ts

@@ -0,0 +1,27 @@
+import {VersionInfo} from './parse-version';
+
+export type VersionType = 'major' | 'minor' | 'patch';


ReleaseType? A version on its own doesn't inherently have a "type" without the context of the versions around it.

We already have ReleaseType. A release type can be either: Major Release, Minor Release, Patch Release, Pre-Release, Stable release or Custom release.

Also, isn't each version that follows Semver either Major Minor or Patch? This is similar to how we have it within the Gulp setup.

I think this is also made clear by the actual Semver rules: e.g. here

jelbourn · 2018-10-16T01:59:03Z

tools/release/version-name/create-version.ts

+ * Creates a new version from the specified version based on the given target version type.
+ * If no target version type has been specified, just the version suffix will be removed.
+ */
+export function createNewVersion(currentVersion: VersionInfo, targetVersionType?: VersionType):


Is there ever a time when the result of this function would be different from expected version for validateExpectedVersion it seems like it could be the same code.

jelbourn · 2018-10-16T02:00:40Z

tools/release/version-name/parse-version.ts

+  }
+
+  return new VersionInfo(
+    parseInt(matches[1]),


Prefer Number to parseInt here

tools/release/prompt/new-version-prompt.ts

jelbourn · 2018-10-16T18:51:03Z

package.json

@@ -63,6 +63,7 @@
    "@types/gulp": "3.8.32",
    "@types/gulp-util": "^3.0.34",
    "@types/hammerjs": "^2.0.35",
+    "@types/inquirer": "^0.0.43",


Add an npm scripts alias for stage release that provides the project directory for you?
(might need a small wrapper script)

Done. We needed a wrapper script because npm scripts do not interpolate environment variables. This should be fine for now.

I will definitely look for ways to improve this, but should be good for an initial implementation.

tools/release/prompt/new-version-prompt.ts

jelbourn · 2018-10-16T19:00:32Z

tools/release/stage-release.ts

+    console.log(cyan('-----------------------------------------'));
+    console.log();
+
+    const newVersion = await promptForNewVersion(this.currentVersion);


Is there anything that validates this new version? Mainly for the case where a custom version is entered.

Yeah, the custom version will be already validated by the validate function which you've simplified with the comment above.

I meant more that the version selected is the correct version, not that it's a valid version. E.g., entering 1.0.0 being incorrect.

This could go in a follow-up, though.

Ah I see, so a custom version can be any valid Semver version that is more recent than the current version right?

Otherwise, if we add more limitations, we could probably remove the "custom-release" once there is a way to create pre-releases with a label

Yeah, removing it might be better because I can't think of a scenario where you'd want to do something abnormal.

I agree. I will remove it in the follow-up that will allow creating a pre-release with custom label.

* Creates an initial release staging script with prompts.

googlebot · 2018-10-16T20:08:04Z

CLAs look good, thanks!

jelbourn

LGTM

jelbourn · 2018-10-16T20:40:47Z

tools/release/stage-release.ts

+    console.log(cyan('-----------------------------------------'));
+    console.log();
+
+    const newVersion = await promptForNewVersion(this.currentVersion);


I meant more that the version selected is the correct version, not that it's a valid version. E.g., entering 1.0.0 being incorrect.

This could go in a follow-up, though.

Implements the functionality to select a pre-release label (as discussed in: angular#13621 (comment))

Implements the functionality to select a pre-release label (as discussed in: #13621 (comment))

angular-automatic-lock-bot · 2019-09-09T22:02:41Z

This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

_{This action has been performed automatically by a bot.}

devversion added area: dev-infra Issue related to internal project infrastructure pr: merge safe target: major This PR is targeted for the next major release labels Oct 15, 2018

devversion assigned jelbourn Oct 15, 2018

devversion requested a review from jelbourn as a code owner October 15, 2018 19:06

googlebot added the cla: yes PR author has agreed to Google's Contributor License Agreement label Oct 15, 2018

devversion changed the title ~~build: initial release automation script~~ build: initial release staging script Oct 15, 2018

devversion force-pushed the build/release-automation-script branch from 668a029 to fe35844 Compare October 15, 2018 19:07

jelbourn reviewed Oct 16, 2018

View reviewed changes

devversion force-pushed the build/release-automation-script branch from a1007cc to 4b8738f Compare October 16, 2018 07:54

jelbourn requested a review from josephperrott October 16, 2018 16:58

jelbourn reviewed Oct 16, 2018

View reviewed changes

This comment has been minimized.

Sign in to view

googlebot added cla: no PR author must sign Google's Contributor License Agreement: https://opensource.google.com/docs/cla and removed cla: yes PR author has agreed to Google's Contributor License Agreement labels Oct 16, 2018

devversion added 2 commits October 16, 2018 21:46

build: initial release staging script

62162b5

* Creates an initial release staging script with prompts.

Address feedback

48a4edc

devversion force-pushed the build/release-automation-script branch from 03fa96e to 48a4edc Compare October 16, 2018 20:08

googlebot added cla: yes PR author has agreed to Google's Contributor License Agreement and removed cla: no PR author must sign Google's Contributor License Agreement: https://opensource.google.com/docs/cla labels Oct 16, 2018

jelbourn approved these changes Oct 16, 2018

View reviewed changes

jelbourn added pr: lgtm action: merge The PR is ready for merge by the caretaker labels Oct 16, 2018

josephperrott merged commit aaac266 into angular:master Oct 17, 2018

devversion added a commit to devversion/material2 that referenced this pull request Nov 9, 2018

chore(stage-release) allow selecting pre-release labels

57252ee

Implements the functionality to select a pre-release label (as discussed in: angular#13621 (comment))

devversion added a commit to devversion/material2 that referenced this pull request Nov 9, 2018

chore(stage-release) allow selecting pre-release labels

733b932

Implements the functionality to select a pre-release label (as discussed in: angular#13621 (comment))

devversion mentioned this pull request Nov 9, 2018

chore(stage-release) allow selecting prerelease labels #14070

Merged

devversion added a commit to devversion/material2 that referenced this pull request Nov 9, 2018

chore(stage-release) allow selecting pre-release labels

65318e4

Implements the functionality to select a pre-release label (as discussed in: angular#13621 (comment))

devversion added a commit to devversion/material2 that referenced this pull request Nov 9, 2018

chore(stage-release) allow selecting pre-release labels

afcc27d

Implements the functionality to select a pre-release label (as discussed in: angular#13621 (comment))

andrewseguin pushed a commit that referenced this pull request Nov 14, 2018

chore(stage-release) allow selecting pre-release labels (#14070)

acedb48

Implements the functionality to select a pre-release label (as discussed in: #13621 (comment))

josephperrott pushed a commit that referenced this pull request Nov 19, 2018

chore(stage-release) allow selecting pre-release labels (#14070)

75b62da

Implements the functionality to select a pre-release label (as discussed in: #13621 (comment))

angular-automatic-lock-bot bot locked and limited conversation to collaborators Sep 9, 2019


		constructor(public projectDir: string) {}

		/** Returns the currently checked out branch for the current working directory. */

		@@ -0,0 +1,27 @@
		import {VersionInfo} from './parse-version';

		export type VersionType = 'major' \| 'minor' \| 'patch';

build: initial release staging script #13621

build: initial release staging script #13621

Uh oh!

Conversation

devversion commented Oct 15, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

devversion Oct 16, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jelbourn Oct 16, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

devversion Oct 16, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

devversion Oct 16, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

devversion Oct 16, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

This comment has been minimized.

This comment has been minimized.

googlebot commented Oct 16, 2018

Uh oh!

jelbourn left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

angular-automatic-lock-bot bot commented Sep 9, 2019

Uh oh!

Uh oh!

devversion commented Oct 15, 2018 •

edited

Loading

devversion Oct 16, 2018 •

edited

Loading

jelbourn Oct 16, 2018 •

edited

Loading

devversion Oct 16, 2018 •

edited

Loading

devversion Oct 16, 2018 •

edited

Loading

devversion Oct 16, 2018 •

edited

Loading