You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* also improve PreparingPatchUpdates.md
- document changes to dependencies.props
- reflect changes in how Templating is handled
- e.g. use EF Core examples
- nit: adjust indentation to avoid markdown warnings
<!-- MicrosoftNETCoreApp21PackageVersion is assigned at the bottom so it can automatically pick up MicrosoftNETCoreAppPackageVersion in an orchestrated build. -->
Copy file name to clipboardExpand all lines: docs/PreparingPatchUpdates.md
+25-19Lines changed: 25 additions & 19 deletions
Original file line number
Diff line number
Diff line change
@@ -16,26 +16,32 @@ In order to prepare this repo to build a new servicing update, the following cha
16
16
* Update the package baselines. This is used to ensure packages keep a consistent set of dependencies between releases.
17
17
See [eng/tools/BaselineGenerator/](/eng/tools/BaselineGenerator/README.md) for instructions on how to run this tool.
18
18
19
+
* **For the subset of external dependencies mentioned at the top of [build/dependencies.props](/build/dependencies.props):**
20
+
If a package (Microsoft.NetCore.App for example) shipped in the last release, update the package version properties.
21
+
22
+
* Changes made above to external dependencies listed in [eng/Baseline.Designer.props](/eng/Baseline.Designer.props)
23
+
should _not_ require further updates. The versions of affected packages should have been updated in
24
+
[build/dependencies.props](/build/dependencies.props) during the previous patching cycle.
25
+
19
26
* **For packages with source code in this repo (not a submodule):** Update the list of packages in [eng/PatchConfig.props](/eng/PatchConfig.props) to list which packages should be patching in this release.
20
27
21
28
* **For packages still building from submodules:** Update the list of repositories which will contain changes in [build/submodules.props](/build/submodules.props).
22
29
23
-
* `<ShippedRepository>` items represent repos which were released in a previous patch, and will not contain servicing updates in the next patch.
24
-
* `<Repository>` items represent repos which will produce new packages in this patch.
25
-
* It is usually best to move everything to `<ShippedRepository>` and then iteratively add them back to `<Repository>` as new repos receive approval to patch.
26
-
* Don't change the `PatchPolicy` attribute. The build system uses this to ensure patching rules are obeyed.
27
-
28
-
* For each repository still listed as a `<Repository>`, update the version.props file in that submodule. For example, https://github.com/aspnet/Templating/pull/824
29
-
30
-
* The version prefix in repos should match the version of ASP.NET Core.
31
-
* Exception: SignalR, which is "1.1", not "2.1".
32
-
* This leaves holes in versioning, which is okay. This may mean you increment the patch value by more than one. Example:
33
-
* EF Core ships patches in 2.1.4 as "2.1.4"
34
-
* EF Core does not ship patches in 2.1.5 or 2.1.6
35
-
* EF Core ships in 2.1.7, therefore, EFCore's version.props file should jump from 2.1.4 to 2.1.7.
36
-
37
-
```diff
38
-
<!-- Example change to modules/EntityFrameworkCore/version.props -->
39
-
- <VersionPrefix>2.1.4</VersionPrefix>
40
-
+ <VersionPrefix>2.1.7</VersionPrefix>
41
-
```
30
+
* `<ShippedRepository>` items represent repos which were released in a previous patch, and will not contain servicing updates in the next patch.
31
+
* `<Repository>` items represent repos which will produce new packages in this patch.
32
+
* It is usually best to move everything to `<ShippedRepository>` and then iteratively add them back to `<Repository>` as new repos receive approval to patch.
33
+
* But, do not change the Templating item at all. That is only _treated_ as a submodule.
34
+
* Don't change the `PatchPolicy` attribute. The build system uses this to ensure patching rules are obeyed.
35
+
36
+
* **For each repository still listed as a `<Repository>`:** Update the version.props file in that submodule. For example, https://github.com/aspnet/EntityFrameworkCore/pull/15369/files#diff-2a92b4d7f8df251ffd3a0aa63e97aad5
37
+
38
+
* This leaves holes in versioning, which is okay. This may mean you increment the patch value by more than one. Example:
39
+
* EF Core ships patches in 2.1.8 as "2.1.8"
40
+
* EF Core does not ship patches in 2.1.9 or 2.1.10
41
+
* EF Core ships in 2.1.11, therefore, EFCore's version.props file should jump from 2.1.8 to 2.1.11.
42
+
43
+
```diff
44
+
<!-- Example change to modules/EntityFrameworkCore/version.props -->
0 commit comments