Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ApiCatalog build infrastructure should be updated #996

Open
safern opened this issue Apr 4, 2019 · 5 comments
Open

ApiCatalog build infrastructure should be updated #996

safern opened this issue Apr 4, 2019 · 5 comments

Comments

@safern
Copy link
Member

safern commented Apr 4, 2019

The ApiCatalog build should just run after the official build and use its artfacts to restore. Also, it should be shared to generate the docs layout that we use for the docs team. I already have some targets to generate the docs layout that I should tweak for this to work for both scenarios.

safern/corefx@099258b

cc: @ahsonkhan @ericstj @carlossanlop

@safern safern self-assigned this Apr 4, 2019
@safern
Copy link
Member Author

safern commented Apr 4, 2019

cc: @danmosemsft

@ericstj
Copy link
Member

ericstj commented Jun 5, 2019

Quick thoughts on how this can work:

  1. See how we construct package versions / flow package versions to the package testing leg.
  2. Make a project that consumes all the relevant packages and not the raw binaries. Consider even generating such a project and saving it as an artifact.
  3. Restore and publish that project to the required directories. Use the PackageId metadata as a means for partitioning inbox vs OOB.

@wtgodbe
Copy link
Member

wtgodbe commented Jun 19, 2019

Here is the plan @safern and I came up with:

@ViktorHofer ViktorHofer transferred this issue from dotnet/corefx Dec 17, 2019
@Dotnet-GitSync-Bot Dotnet-GitSync-Bot added area-Infrastructure-libraries untriaged New issue has not been triaged by the area owner labels Dec 17, 2019
@ViktorHofer ViktorHofer added this to To do in Infrastructure - Developer Productivity via automation Dec 17, 2019
@ViktorHofer ViktorHofer added this to the 5.0 milestone Dec 17, 2019
@ViktorHofer ViktorHofer removed the untriaged New issue has not been triaged by the area owner label Dec 17, 2019
@wtgodbe wtgodbe removed their assignment Feb 3, 2020
@maryamariyan maryamariyan added the untriaged New issue has not been triaged by the area owner label Feb 23, 2020
@ericstj ericstj removed the untriaged New issue has not been triaged by the area owner label Jun 23, 2020
@Anipik Anipik modified the milestones: 5.0.0, 6.0.0 Jul 16, 2020
MichalStrehovsky pushed a commit to MichalStrehovsky/runtime that referenced this issue Jul 1, 2021
@Anipik Anipik modified the milestones: 6.0.0, 7.0.0 Aug 4, 2021
@Anipik Anipik moved this from 6.0.0 to 7.0.0 in Infrastructure Backlog Aug 4, 2021
@ghost ghost moved this from 7.0.0 to Untriaged in Infrastructure Backlog Aug 4, 2021
@ViktorHofer ViktorHofer moved this from Untriaged to 7.0.0 in Infrastructure Backlog Sep 3, 2021
@safern safern removed their assignment Feb 22, 2022
@carlossanlop carlossanlop self-assigned this Jul 6, 2022
@carlossanlop carlossanlop modified the milestones: 7.0.0, 8.0.0 Jul 6, 2022
@ViktorHofer
Copy link
Member

@carlossanlop should this issue be closed now?

@ViktorHofer
Copy link
Member

ViktorHofer commented Jul 12, 2023

The docs team needs the following assets from repositories:

  • Reference assemblies
  • compiler generated XML files (for triple-slash source of truth projects)

Instead of having an orchestration point (currently apicatalog-infra repo) that bundles all the assets together from different repositories and which is a completely manually process today, we could design a push model. Any repository that needs/wants to participate in the docs team process, would generate their own transport package.

Example name pattern: Microsoft.Internal.[SourceRepo].[TargetRepo].Transport.nupkg

ViktorHofer added a commit that referenced this issue Jul 21, 2023
Contributes to #996.

Add a nuget package that contains all the reference assemblies and
source-of-truth API docs XML files for the current release.
ViktorHofer added a commit that referenced this issue Jul 31, 2023
…89312)

* Create docs ref+xml transport package

Contributes to #996.

Add a nuget package that contains all the reference assemblies and
source-of-truth API docs XML files for the current release.

* Turn on source of truth for Microsoft.Extensions.*

Make the source of truth for API docs for the Microsoft.Extensions.*
libraries dotnet/runtime instead of the intellisense package.

Disable the few projects that aren't yet documented. Same for libraries
that are already effectively source-of-truth in runtime but which aren't
documented.

* Add missing triple slash docs in Primitives

* Fill in missing keyed DI doc comments.

* Add memory cache triple slash docs

* Add more missing docs

* Add more missing docs

* More missing docs

* More docs

* More

* Add Microsoft.Extensions.Logging.Console docs

* Microsoft.Extensions.Hosting docs

* Exclude Microsoft.Bcl.*

* Update src/libraries/Microsoft.Internal.Runtime.DotNetApiDocs.Transport/src/Microsoft.Internal.Runtime.DotNetApiDocs.Transport.proj

Co-authored-by: Carlos Sánchez López <1175054+carlossanlop@users.noreply.github.com>

---------

Co-authored-by: Tarek Mahmoud Sayed <tarekms@microsoft.com>
Co-authored-by: Aditya Mandaleeka <adityam@microsoft.com>
Co-authored-by: Carlos Sánchez López <1175054+carlossanlop@users.noreply.github.com>
@ericstj ericstj modified the milestones: 8.0.0, 9.0.0 Aug 14, 2023
@ViktorHofer ViktorHofer modified the milestones: 9.0.0, Future Jul 22, 2024
@ViktorHofer ViktorHofer removed their assignment Jul 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Development

Successfully merging a pull request may close this issue.

8 participants