mirror of
https://github.com/angular/angular
synced 2026-05-24 09:28:37 +00:00
b8fd0da47f
Add a new doc, `aio/UPDATING.md`, with instructions on updating the angular.io app to align with the latest Angular CLI/framework/Material. Also, update the instructions on updating the docs examples apps. PR Close #47250
42 lines
2.5 KiB
Markdown
42 lines
2.5 KiB
Markdown
# Update the angular.io app
|
|
|
|
The dependencies of the angular.io app (including Angular, Angular Material and Angular CLI) are automatically updated using [Renovate](https://renovatebot.com/).
|
|
|
|
However, it is useful to periodically also manually update the app to more closely match (in file layout, configs, etc.) what a new Angular CLI app would look like.
|
|
This is typically only needed once for each new major Angular version.
|
|
|
|
Since angular.io is an Angular CLI app, we can take advantage of `ng update` to apply migrations.
|
|
|
|
Follow these steps to align the angular.io app with new CLI apps.
|
|
|
|
> **Note:**
|
|
> The following steps assume that the related Angular dependencies have already been updated in [aio/package.json](./package.json) (for example, automatically by Renovate).
|
|
|
|
> **Note:**
|
|
> All commands shown below are expected to be executed from inside the [aio/](./) directory (unless specified otherwise).
|
|
|
|
- Determine (for example, by examining git history) what is the last versions for which this process was performed.
|
|
These will be referred to as `<FROM_VERSION_*>`.
|
|
If you can't determine these, use arbitrary versions, such as the previous major version.
|
|
|
|
- Run the following commands to automatically apply any available migrations to the project:
|
|
```sh
|
|
# Ensure dependencies are installed.
|
|
yarn install
|
|
|
|
# Migrate project to new versions.
|
|
yarn ng update @angular/cli --allow-dirty --migrate-only --from=<FROM_VERSION_CLI>
|
|
yarn ng update @angular/core --allow-dirty --migrate-only --from=<FROM_VERSION_ANGULAR>
|
|
yarn ng update @angular/material --allow-dirty --migrate-only --from=<FROM_VERSION_MATERIAL>
|
|
```
|
|
|
|
> **Note:**
|
|
> Depending on the number of changes generated from each `ng update` command, it might make sense to create a separate commit for each update.
|
|
|
|
- Inspect [package.json](./package.json) to determine what is the current version of Angular CLI (i.e. `@angular/cli`) used in the app.
|
|
This will be referred to as `<TO_VERSION_CLI>`.
|
|
|
|
- Use the [angular-cli-diff](https://github.com/cexbrayat/angular-cli-diff) repository to discover more changes (which are not automatically applied via `ng update` migrations) between Angular CLI apps of different versions.
|
|
Visit https://github.com/cexbrayat/angular-cli-diff/compare/<FROM_VERSION_CLI>...<TO_VERSION_CLI>, inspect the changes between the two versions and apply the ones that make sense to the angular.io source code.
|
|
|
|
- Commit all changes and [submit a pull request](../CONTRIBUTING.md#submit-pr).
|