Skip to content

Correct path to gather API docs artifacts in CI#22737

Merged
rmarinho merged 3 commits into
mainfrom
fix-22736
May 31, 2024
Merged

Correct path to gather API docs artifacts in CI#22737
rmarinho merged 3 commits into
mainfrom
fix-22736

Conversation

@jfversluis
Copy link
Copy Markdown
Member

@jfversluis jfversluis commented May 30, 2024

Description of Change

Correctly gathers the artifacts needed to fill the xml-docs artifact that is used to populate the online API docs browser.

Additionally, this now also gathers pdb files to enable new functionality in the online API docs browser that enables links from said browser straight into our code repository.

You can verify this PR works correctly by going to the build in Azure Pipelines, inspect the artifacts and see that that has a xml-docs artifact which is filled with dll, xml and pdb files.

This PR also has some minor changes in actual docs to fix the docs build system warnings.

Issues Fixed

Fixes #22736

@jfversluis jfversluis added area-docs Conceptual docs, API docs, Samples t/housekeeping ♻︎ area-infrastructure CI, Maestro / Coherency, upstream dependencies/versions labels May 30, 2024
@jfversluis jfversluis marked this pull request as ready for review May 31, 2024 13:53
@jfversluis jfversluis requested a review from a team as a code owner May 31, 2024 13:53
@jfversluis
Copy link
Copy Markdown
Member Author

Verified the artifacts are filled and results on the API docs browser look good with this so ready for review!

@jfversluis jfversluis requested review from mattleibow and removed request for tj-devel709 May 31, 2024 13:54
@jfversluis jfversluis enabled auto-merge (squash) May 31, 2024 18:37
@rmarinho rmarinho disabled auto-merge May 31, 2024 20:56
@rmarinho rmarinho merged commit 4e9ac2a into main May 31, 2024
@rmarinho rmarinho deleted the fix-22736 branch May 31, 2024 20:57
jfversluis added a commit that referenced this pull request Jun 3, 2024
* Correct path to gather API docs artifacts in CI

* Update Application.xml

* Filter more non-useful files
@github-actions github-actions Bot locked and limited conversation to collaborators Jul 1, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

area-docs Conceptual docs, API docs, Samples area-infrastructure CI, Maestro / Coherency, upstream dependencies/versions fixed-in-8.0.60 fixed-in-9.0.0-preview.5.24307.10 t/housekeeping ♻︎

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Reinstate xml-docs build artifact for easier API docs publication

4 participants