Skip to content

Commit 3d10eb1

Browse files
committed
Clean-up pkgproj leftovers in libs and apply fixes
Remove any pkgproj infrastructure that was only used by src/libraries (which is the majority). Delete the packageindex *YAY*. Update the documentation that covered the packageindex and the pkgprojs. Avoid any incremental builds during packaging by removing libraries-packages.proj and use src.proj for packaging instead. Make use of the `GeneratePackageOnBuild` property to build package during the allconfigurations without requiring a different entry target. Fix the addition of the DocumentationFile during packaging when `GeneratePackageOnBuid` is used by hooking onto the `DocumentationProjectOutputGroup` that NuGet uses and replacing the generated documentation file with the one that comes via the intellisense package. Also introduce a property to choose the generated documentation file over the one from the intellisense package: <UseIntellisenseDocumentationFile>false</UseIntellisenseDocumentationFile> Removing a few leftover PackageDescription properties from the projects' Directory.Build.props file. Cleaning up properties in Directory.Build.props & Directory.Build.targets files.
1 parent f61d5c8 commit 3d10eb1

File tree

30 files changed

+110
-8631
lines changed

30 files changed

+110
-8631
lines changed

Directory.Build.targets

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,8 +54,6 @@
5454
<PackageDescription Condition="'$(PackageDescription)' == '' and '$(UseRuntimePackageDisclaimer)' == 'true'">$(RuntimePackageDisclaimer)</PackageDescription>
5555
<!-- Keep in sync as required by the Packaging SDK in Arcade. -->
5656
<Description>$(PackageDescription)</Description>
57-
<!-- BeforePack hook should be removed after porting all the projects to dotnet pack. -->
58-
<BeforePack>$(BeforePack);AddNETStandardCompatErrorFileForPackaging</BeforePack>
5957
<GenerateNuspecDependsOn>AddNETStandardCompatErrorFileForPackaging;$(GenerateNuspecDependsOn)</GenerateNuspecDependsOn>
6058
</PropertyGroup>
6159

docs/coding-guidelines/adding-api-guidelines.md

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -29,12 +29,6 @@ should be added to `net5.0`. [More Information on TargetFrameworks](https://docs
2929

3030
## Making the changes in repo
3131

32-
**Update pkg**
33-
- If changing the target framework
34-
- Update `SupportedFramework` metadata on the ref ProjectReference to declare the set of concrete platforms you expect your library to support. (see [Specific platform mappings][net-standard table]). Generally will be a combination of netcoreapp2.x, netfx46x, and/or `$(AllXamarinFrameworks)`.
35-
- If assembly or package version is updated the package index needs to be updated by running
36-
`dotnet build <Library>/pkg/<Library>.pkgproj /t:UpdatePackageIndex`
37-
3832
**Update tests**
3933
- Add new `TargetFramework` to the ```TargetFrameworks```.
4034
- Add new test code following [conventions](project-guidelines.md#code-file-naming-conventions) for new files to that are specific to the new target framework.
@@ -52,10 +46,6 @@ Once the dotnet-api-docs change is merged, your comments will start showing up i
5246
Once the documentation is official, any subsequent updates to it must be made directly in https://github.com/dotnet/dotnet-api-docs/. It's fine to make updates to the triple slash comments later, they just won't automatically flow into the official docs.
5347

5448
## FAQ
55-
_**How do I consume APIs from another package that aren't yet published?**_
56-
57-
If you are adding APIs across multiple packages at the same time. You can temporarily add a direct
58-
ProjectReference from the ref\csproj to the ref\csproj, src\csproj to the ref\csproj, and/or tests\csproj to pkg\pkgproj. Once a new set of packages have been published these ProjectReferences should be removed.
5949

6050
_**What to do if you are moving types down into a lower contract?**_
6151

docs/coding-guidelines/libraries-packaging.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Removing a library from this transport package is a breaking change and should b
3636

3737
## NuGet package
3838

39-
Libraries to be packaged must be referenced by the [traversal packaging project](../../src/libraries/libraries-packages.proj) and set `IsPackable` to true. By default, all `Libraries/*/src` projects are considered for packaging.
39+
Libraries to be packaged must set `IsPackable` to true. By default, all `libraries/*/src` projects are considered for packaging.
4040

4141
Package versions and shipping state should be controlled using the properties defined by the [Arcade SDK](https://github.com/dotnet/arcade/blob/master/Documentation/ArcadeSdk.md#project-properties-defined-by-the-sdk). Typically libraries should not need to explicitly set any of these properties.
4242

docs/coding-guidelines/package-projects.md

Lines changed: 0 additions & 163 deletions
This file was deleted.

docs/coding-guidelines/project-guidelines.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -151,9 +151,6 @@ All src outputs are under
151151

152152
`bin\$(MSBuildProjectName)\$(TargetFramework)`
153153

154-
## pkg
155-
In the pkg directory for the library there should be only **one** `.pkgproj` for the primary package for the library. If the library has platform-specific implementations those should be split into platform specific projects in a subfolder for each platform. (see [Package projects](./package-projects.md))
156-
157154
## tests
158155
Similar to the src projects tests projects will define a `TargetFrameworks` property so they can list out the set of target frameworks they support.
159156

0 commit comments

Comments
 (0)