Previously, `ExampleZipper` (the tool used for creating ZIP archives from our docs examples) used the `PackageJsonCustomizer` to generate `package.json` files for each example type. This had the following drawbacks: - The generated files had to be kept up-to-date with the corresponding boilerplate files in `aio/tools/examples/shared/boilerplate/` and there was no easy way to find out when the files got out-of-sync. - The `PackageJsonCustomizer` logic was non-trivial and difficult to reason about. - The same information was duplicated in the boilerplate files and the customizer configuration files. This setup was useful when we used a single `package.json` file for all docs examples. Now, however, each example type can have its own boilerplate `package.json` file, including scripts and dependencies relevant to the example type. Therefore, it is no longer necessary to generate `package.json` files for ZIP archives. This commit eliminates the drawbacks mentioned above and simplifies the `ExampleZipper` tool by removing `PackageJsonCustomizer` and re-using the boilerplate `package.json` files for ZIP archives. The changes in this commit also fix some ZIP archives that were previously broken (for example due to missing dependencies). PR Close #38192
17 lines
610 B
Markdown
17 lines
610 B
Markdown
# Docs releases
|
|
|
|
This document explains how to update the documentation examples after an Angular release. This is only needed for major and minor versions.
|
|
|
|
All the packages for the docs' examples are specified in `/aio/tools/examples/shared/package.json`
|
|
|
|
**1)** So within the `shared` folder, you need to issue the following command:
|
|
|
|
```
|
|
$ yarn upgrade-interactive --tilde
|
|
```
|
|
|
|
There, select all the packages that are updated on the new Angular release.
|
|
|
|
**2)** Changes to the tsconfig.json? There are several files in `/aio/tools/examples/shared/boilerplate/*/tsconfig.json` (based on the example type).
|
|
|