build(docs-infra): update angular.io deployments to match new versioning/branching process by gkalpak · Pull Request #39470 · angular/angular

gkalpak · 2020-10-28T15:52:17Z

This PR updates AIO deployments to match our new versioning/branching process (including deploying release-candidate versions to angular.io).

See individual commits for more info.

This is part of the work tracked in #39366.

This PR is based on #37280 (but includes extra changes/improvements).

This commit switches the `deploy-to-firebase.sh` script, that we use for deploying angular.io to production, from Bash to JavaScript. This makes the script easier to maintain. For the same reasons, it also switches the `deploy-to-firebase.test.sh` script, that we use for testing the `deploy-to-firebase` script, from Bash to JavaScript (using jasmine as the test runner). Finally, this commit also updates ShellJS to the latest version to get better error messages (including the actual error) when `exec()` fails. NOTE: Before switching the test script to JS, I verified that the new `deploy-to-firebase.js` script passed the tests with the old `deploy-to-firebase.test.sh` script.

mary-poppins · 2020-10-28T16:02:40Z

You can preview 9caf354 at https://pr39470-9caf354.ngbuilds.io/.

Previously, the `deploy-to-firebase.js` script and the accompanying `deploy-to-firebase.spec.js` spec file were using the `origin` remote alias in certain commands. This works fine on CI, where `origin` points to the `angular/angular` GitHub repo, but might not work locally. This commit ensures that the correct remote is used by explicitly specifying it by the URL, thus ensuring that the tests will behave identically on CI and locally.

mary-poppins · 2020-10-28T18:03:18Z

You can preview 82e0458 at https://pr39470-82e0458.ngbuilds.io/.

mary-poppins · 2020-10-28T19:15:52Z

You can preview 5dd1280 at https://pr39470-5dd1280.ngbuilds.io/.

mary-poppins · 2020-10-28T20:03:33Z

You can preview d102032 at https://pr39470-d102032.ngbuilds.io/.

petebacondarwin

LGTM - a handful of NITs - nothing blocking.
The 3rd commit message has some typos mentioned offline.

petebacondarwin · 2020-10-30T11:21:24Z

NIT - I would change $darkColor to something like $accentColor, since it is not always dark! See the archive mode for an example.

Good point. I was between $darkColor and $gradientTargetColor (since that is what it is used currently). I'll go with the latter.

petebacondarwin · 2020-10-30T11:41:10Z

Would it be worth keeping the dry-run feature in case you just wanted to try out running the script locally? Or is this never going to be needed?

I've never needed to dry-run it locally, but happy to keep the option.

…oyment mode themes Different deployment modes (such as `archive` and `next`) are identified by the different colors used in prominent elements of the page, such as the topbar and the footer. Previously, the necessary styles for creating such a deployment mode "theme" were duplicated for each mode. This commit simplifies the creation/modification of a deployment mode theme by introducing a Sass mixin that generates the necessary styles (when provided with necessary theme colors).

…of deployment mode themes

…-candidates This commit adds a new build configuration/deployment mode (`rc`) for deploying release-candidate versions to angular.io. This is part of the work needed to prepare angular.io for our [new versioning/branching process][1] (also tracked in angular#39366). [1]: https://docs.google.com/document/d/197kVillDwx-RZtSVOBtPb4BBIAw0E9RT3q3v6DZkykU

…oyment mode themes (#39470) Different deployment modes (such as `archive` and `next`) are identified by the different colors used in prominent elements of the page, such as the topbar and the footer. Previously, the necessary styles for creating such a deployment mode "theme" were duplicated for each mode. This commit simplifies the creation/modification of a deployment mode theme by introducing a Sass mixin that generates the necessary styles (when provided with necessary theme colors). PR Close #39470

…-candidates (#39470) This commit adds a new build configuration/deployment mode (`rc`) for deploying release-candidate versions to angular.io. This is part of the work needed to prepare angular.io for our [new versioning/branching process][1] (also tracked in #39366). [1]: https://docs.google.com/document/d/197kVillDwx-RZtSVOBtPb4BBIAw0E9RT3q3v6DZkykU PR Close #39470

#39470) This commit updates the angular.io deployment script (`deploy-to-firebase.js`) to support deploying release-candidate versions. This is part of the work needed to prepare angular.io for our [new versioning/branching process][1] (also tracked in #39366). [1]: https://docs.google.com/document/d/197kVillDwx-RZtSVOBtPb4BBIAw0E9RT3q3v6DZkykU PR Close #39470

…nctions (#39470) This commit breaks up the code in `deploy-to-firebase.js` script, that we use for deploying angular.io to production, to smaller functions (instead of a monolithic block). This makes the script easier to maintain and also makes testing individual operations easier. The commit also updates the `deploy-to-firebase.spec.js` spec file to take advantage of the standalone functions to speed up testing by calling the corresponding function instead of having to spawn a new process and run the `deploy-to-firebase.js` script with the `--dry-run` flag. NOTE: Before updating the tests, I verified that the updated `deploy-to-firebase.js` script passed the old tests. PR Close #39470

Previously, the documentation for each major Angular version was hosted on each own Firebase project. This required creating a new project for each major release and increased the administrative/maintenance cost. Now that Firebase supports hosting [multiple websites][1] as part of the same project, we are switching to deploying all major versions to sites created on `angular-io` project. This is part of the work needed to prepare angular.io for our [new versioning/branching process][2] (also tracked in #39366). [1]: https://firebase.google.com/docs/hosting/multisites [2]: https://docs.google.com/document/d/197kVillDwx-RZtSVOBtPb4BBIAw0E9RT3q3v6DZkykU PR Close #39470

This commit upgrades `firebase-tools` (used to deploy angular.io to Firebase hosting) to the latest version. This gives us access to the latest fixes/improvements and also new features, such as [version cloning][1]. [1]: https://firebase.google.com/docs/hosting/manage-hosting-resources#cli-commands-cloning PR Close #39470

) Previously, the `deploy-to-firebase.js` script and the accompanying `deploy-to-firebase.spec.js` spec file were using the `origin` remote alias in certain commands. This works fine on CI, where `origin` points to the `angular/angular` GitHub repo, but might not work locally. This commit ensures that the correct remote is used by explicitly specifying it by the URL, thus ensuring that the tests will behave identically on CI and locally. PR Close #39470

…oyment mode themes (#39470) Different deployment modes (such as `archive` and `next`) are identified by the different colors used in prominent elements of the page, such as the topbar and the footer. Previously, the necessary styles for creating such a deployment mode "theme" were duplicated for each mode. This commit simplifies the creation/modification of a deployment mode theme by introducing a Sass mixin that generates the necessary styles (when provided with necessary theme colors). PR Close #39470

…-candidates (#39470) This commit adds a new build configuration/deployment mode (`rc`) for deploying release-candidate versions to angular.io. This is part of the work needed to prepare angular.io for our [new versioning/branching process][1] (also tracked in #39366). [1]: https://docs.google.com/document/d/197kVillDwx-RZtSVOBtPb4BBIAw0E9RT3q3v6DZkykU PR Close #39470

#39470) This commit updates the angular.io deployment script (`deploy-to-firebase.js`) to support deploying release-candidate versions. This is part of the work needed to prepare angular.io for our [new versioning/branching process][1] (also tracked in #39366). [1]: https://docs.google.com/document/d/197kVillDwx-RZtSVOBtPb4BBIAw0E9RT3q3v6DZkykU PR Close #39470

…nctions (#39470) This commit breaks up the code in `deploy-to-firebase.js` script, that we use for deploying angular.io to production, to smaller functions (instead of a monolithic block). This makes the script easier to maintain and also makes testing individual operations easier. The commit also updates the `deploy-to-firebase.spec.js` spec file to take advantage of the standalone functions to speed up testing by calling the corresponding function instead of having to spawn a new process and run the `deploy-to-firebase.js` script with the `--dry-run` flag. NOTE: Before updating the tests, I verified that the updated `deploy-to-firebase.js` script passed the old tests. PR Close #39470

Previously, the documentation for each major Angular version was hosted on each own Firebase project. This required creating a new project for each major release and increased the administrative/maintenance cost. Now that Firebase supports hosting [multiple websites][1] as part of the same project, we are switching to deploying all major versions to sites created on `angular-io` project. This is part of the work needed to prepare angular.io for our [new versioning/branching process][2] (also tracked in #39366). [1]: https://firebase.google.com/docs/hosting/multisites [2]: https://docs.google.com/document/d/197kVillDwx-RZtSVOBtPb4BBIAw0E9RT3q3v6DZkykU PR Close #39470

This commit upgrades `firebase-tools` (used to deploy angular.io to Firebase hosting) to the latest version. This gives us access to the latest fixes/improvements and also new features, such as [version cloning][1]. [1]: https://firebase.google.com/docs/hosting/manage-hosting-resources#cli-commands-cloning PR Close #39470

This commit switches the `deploy-to-firebase.sh` script, that we use for deploying angular.io to production, from Bash to JavaScript. This makes the script easier to maintain. For the same reasons, it also switches the `deploy-to-firebase.test.sh` script, that we use for testing the `deploy-to-firebase` script, from Bash to JavaScript (using jasmine as the test runner). Finally, this commit also updates ShellJS to the latest version to get better error messages (including the actual error) when `exec()` fails. NOTE: Before switching the test script to JS, I verified that the new `deploy-to-firebase.js` script passed the tests with the old `deploy-to-firebase.test.sh` script. PR Close #39470

) Previously, the `deploy-to-firebase.js` script and the accompanying `deploy-to-firebase.spec.js` spec file were using the `origin` remote alias in certain commands. This works fine on CI, where `origin` points to the `angular/angular` GitHub repo, but might not work locally. This commit ensures that the correct remote is used by explicitly specifying it by the URL, thus ensuring that the tests will behave identically on CI and locally. PR Close #39470

…oyment mode themes (#39470) Different deployment modes (such as `archive` and `next`) are identified by the different colors used in prominent elements of the page, such as the topbar and the footer. Previously, the necessary styles for creating such a deployment mode "theme" were duplicated for each mode. This commit simplifies the creation/modification of a deployment mode theme by introducing a Sass mixin that generates the necessary styles (when provided with necessary theme colors). PR Close #39470

…-candidates (#39470) This commit adds a new build configuration/deployment mode (`rc`) for deploying release-candidate versions to angular.io. This is part of the work needed to prepare angular.io for our [new versioning/branching process][1] (also tracked in #39366). [1]: https://docs.google.com/document/d/197kVillDwx-RZtSVOBtPb4BBIAw0E9RT3q3v6DZkykU PR Close #39470

#39470) This commit updates the angular.io deployment script (`deploy-to-firebase.js`) to support deploying release-candidate versions. This is part of the work needed to prepare angular.io for our [new versioning/branching process][1] (also tracked in #39366). [1]: https://docs.google.com/document/d/197kVillDwx-RZtSVOBtPb4BBIAw0E9RT3q3v6DZkykU PR Close #39470

…nctions (#39470) This commit breaks up the code in `deploy-to-firebase.js` script, that we use for deploying angular.io to production, to smaller functions (instead of a monolithic block). This makes the script easier to maintain and also makes testing individual operations easier. The commit also updates the `deploy-to-firebase.spec.js` spec file to take advantage of the standalone functions to speed up testing by calling the corresponding function instead of having to spawn a new process and run the `deploy-to-firebase.js` script with the `--dry-run` flag. NOTE: Before updating the tests, I verified that the updated `deploy-to-firebase.js` script passed the old tests. PR Close #39470

Previously, the documentation for each major Angular version was hosted on each own Firebase project. This required creating a new project for each major release and increased the administrative/maintenance cost. Now that Firebase supports hosting [multiple websites][1] as part of the same project, we are switching to deploying all major versions to sites created on `angular-io` project. This is part of the work needed to prepare angular.io for our [new versioning/branching process][2] (also tracked in #39366). [1]: https://firebase.google.com/docs/hosting/multisites [2]: https://docs.google.com/document/d/197kVillDwx-RZtSVOBtPb4BBIAw0E9RT3q3v6DZkykU PR Close #39470

This commit upgrades `firebase-tools` (used to deploy angular.io to Firebase hosting) to the latest version. This gives us access to the latest fixes/improvements and also new features, such as [version cloning][1]. [1]: https://firebase.google.com/docs/hosting/manage-hosting-resources#cli-commands-cloning PR Close #39470

In angular#39470, the `deploy-to-firebase.sh` script (used to deploy AIO to Firebase when building an upstream branch), was replaced by an equivalent JS script. In this new `deploy-to-firebase.js` script, we were overly aggressive with suppressing command output, which made it hard to investigate failures ([example failing CI job][1]). This commit updates the `deploy-to-firebase.js` script to capture command output as usual in the CI job logs. This makes the output similar to the one generated by the old [deploy-to-firebase.sh][2] script ([example CI logs][3]). One concern with capturing command output is having the value of a secret environment variables leaked in the logs. This is not the case here, since: 1. The secret env vars are not printed from the commands that use them. 2. CircleCI will [mask the values of secret env vars][4] in the output. As an extra precaution (although not strictly necessary), we run `yarn` with the `--silent` option, which avoid echoing the executed yarn commands. [1]: https://circleci.com/gh/angular/angular/849310 [2]: https://github.com/angular/angular/blob/3b0b7d22109c79b4dceb/aio/scripts/deploy-to-firebase.sh [3]: https://circleci.com/gh/angular/angular/848109 [4]: https://circleci.com/docs/2.0/env-vars/#secrets-masking

In #39470, the `deploy-to-firebase.sh` script (used to deploy AIO to Firebase when building an upstream branch), was replaced by an equivalent JS script. In this new `deploy-to-firebase.js` script, we were overly aggressive with suppressing command output, which made it hard to investigate failures ([example failing CI job][1]). This commit updates the `deploy-to-firebase.js` script to capture command output as usual in the CI job logs. This makes the output similar to the one generated by the old [deploy-to-firebase.sh][2] script ([example CI logs][3]). One concern with capturing command output is having the value of a secret environment variables leaked in the logs. This is not the case here, since: 1. The secret env vars are not printed from the commands that use them. 2. CircleCI will [mask the values of secret env vars][4] in the output. As an extra precaution (although not strictly necessary), we run `yarn` with the `--silent` option, which avoid echoing the executed yarn commands. [1]: https://circleci.com/gh/angular/angular/849310 [2]: https://github.com/angular/angular/blob/3b0b7d22109c79b4dceb/aio/scripts/deploy-to-firebase.sh [3]: https://circleci.com/gh/angular/angular/848109 [4]: https://circleci.com/docs/2.0/env-vars/#secrets-masking PR Close #39596

angular-automatic-lock-bot · 2020-12-03T16:30:47Z

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.}

google-cla Bot added the cla: yes label Oct 28, 2020

gkalpak mentioned this pull request Oct 28, 2020

build(docs-infra): add deployment mode for release-candidate versions #37280

Closed

josephperrott added the comp: docs-infra label Oct 28, 2020

ngbot Bot added this to the needsTriage milestone Oct 28, 2020

gkalpak force-pushed the build-aio-deploy-rc-2.0 branch from 9caf354 to 82e0458 Compare October 28, 2020 17:52

gkalpak force-pushed the build-aio-deploy-rc-2.0 branch from 82e0458 to 5dd1280 Compare October 28, 2020 19:02

gkalpak changed the title ~~WIP - build(docs-infra): update angular.io deployments to match new versioning/branching process~~ build(docs-infra): update angular.io deployments to match new versioning/branching process Oct 28, 2020

gkalpak added area: build & ci Related the build and CI infrastructure of the project target: patch This PR is targeted for the next patch release action: review The PR is still awaiting reviews from at least one requested reviewer labels Oct 28, 2020

gkalpak modified the milestones: needsTriage, docs-infra-aio-app Oct 28, 2020

gkalpak marked this pull request as ready for review October 28, 2020 20:39

josephperrott requested a review from petebacondarwin October 29, 2020 18:25

petebacondarwin approved these changes Oct 30, 2020

View reviewed changes

petebacondarwin added the action: cleanup The PR is in need of cleanup, either due to needing a rebase or in response to comments from reviews label Oct 30, 2020

gkalpak force-pushed the build-aio-deploy-rc-2.0 branch from d102032 to e482702 Compare October 31, 2020 22:17

gkalpak removed the action: review The PR is still awaiting reviews from at least one requested reviewer label Oct 31, 2020

gkalpak added 3 commits November 1, 2020 00:20

fixup! refactor(docs-infra): use Sass mixin to simplify the creation …

417e4b3

…of deployment mode themes

josephperrott closed this in 5143d52 Nov 2, 2020

gkalpak deleted the build-aio-deploy-rc-2.0 branch November 2, 2020 19:18

angular-automatic-lock-bot Bot locked and limited conversation to collaborators Dec 3, 2020

Navigation Menu

build(docs-infra): update angular.io deployments to match new versioning/branching process - #39470

build(docs-infra): update angular.io deployments to match new versioning/branching process#39470
gkalpak wants to merge 10 commits into
angular:masterfrom
gkalpak:build-aio-deploy-rc-2.0

gkalpak commented Oct 28, 2020 •

edited

Loading

Uh oh!

mary-poppins commented Oct 28, 2020

Uh oh!

mary-poppins commented Oct 28, 2020

Uh oh!

mary-poppins commented Oct 28, 2020

Uh oh!

mary-poppins commented Oct 28, 2020

Uh oh!

petebacondarwin left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

petebacondarwin Oct 30, 2020

Uh oh!

gkalpak Oct 31, 2020

Uh oh!

Uh oh!

petebacondarwin Oct 30, 2020

Uh oh!

gkalpak Oct 31, 2020

Uh oh!

Uh oh!

angular-automatic-lock-bot Bot commented Dec 3, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

gkalpak commented Oct 28, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mary-poppins commented Oct 28, 2020

Uh oh!

mary-poppins commented Oct 28, 2020

Uh oh!

mary-poppins commented Oct 28, 2020

Uh oh!

mary-poppins commented Oct 28, 2020

Uh oh!

petebacondarwin left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

petebacondarwin Oct 30, 2020

Choose a reason for hiding this comment

Uh oh!

gkalpak Oct 31, 2020

Choose a reason for hiding this comment

Uh oh!

Uh oh!

petebacondarwin Oct 30, 2020

Choose a reason for hiding this comment

Uh oh!

gkalpak Oct 31, 2020

Choose a reason for hiding this comment

Uh oh!

Uh oh!

angular-automatic-lock-bot Bot commented Dec 3, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

gkalpak commented Oct 28, 2020 •

edited

Loading