Skip to content

Split doc generation pipeline into parallel v1.0 and beta stages - #825

Open
ramsessanchez wants to merge 2 commits into
ramsess/revert-generation-changesfrom
ramsess/split-docs-by-profile-v2
Open

Split doc generation pipeline into parallel v1.0 and beta stages#825
ramsessanchez wants to merge 2 commits into
ramsess/revert-generation-changesfrom
ramsess/split-docs-by-profile-v2

Conversation

@ramsessanchez

Copy link
Copy Markdown
Contributor

Splits the weekly reference-docs generation into two independent, parallel stages so v1.0 and beta each produce their own PR.

What changed

  • New reusable template azure-pipelines/common-templates/generate-docs-steps.yml runs the full generation + post-processing pipeline for a single profile.
  • azure-pipelines/powershell-docs.yml now defines two parallel stages, GenerateV1 and GenerateBeta (dependsOn: []), each consuming the template with GraphProfileFilter = v1.0 / beta, its own branch prefix, PR title, and uniquely-named MissingExternalDocs artifact.
  • All generation/post-processing scripts gained a -GraphProfileFilter parameter (v1.0 | beta | both, default both) so a run can be scoped to one profile. Authentication docs (v1.0-only) are skipped when generating beta.

Base

Stacks on ramsess/revert-generation-changes (#819) — this PR shows only the split changes on top of the mass-deletion / idempotency / encoding fixes. StabilizeMsDate is intentionally not reintroduced (it was removed on that branch).

Redo of #806 on the corrected base.

Co-authored-by: Copilot 223556219+Copilot@users.noreply.github.com

Adds a -GraphProfileFilter parameter (v1.0/beta/both, default both) to the generation and post-processing scripts so each profile can be generated independently, and splits powershell-docs.yml into two parallel stages (GenerateV1, GenerateBeta) via a new reusable common-templates/generate-docs-steps.yml. Each stage generates a single profile, commits to its own branch, and opens its own PR. Built on top of the mass-deletion, idempotency and encoding fixes from ramsess/revert-generation-changes; StabilizeMsDate is intentionally not included as it was removed on that branch.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot-Session: 4d27d82f-3809-40d2-b4e7-6623436ff2ef
@learn-build-service-prod

Copy link
Copy Markdown
Contributor

PoliCheck Scan Report

The following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 and severity-2 issues. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans.

✅ No issues found

More information about PoliCheck

Information: PoliCheck | Severity Guidance | Term
For any questions: Try searching the learn.microsoft.com contributor guides or post your question in the Learn support channel.

@learn-build-service-prod

Copy link
Copy Markdown
Contributor

Learn Build status updates of commit 07827a2:

✅ Validation status: passed

File Status Preview URL Details
azure-pipelines/common-templates/generate-docs-steps.yml ✅Succeeded
azure-pipelines/powershell-docs.yml ✅Succeeded
scripts/CorrectRelatedLinks-AllFiles.ps1 ✅Succeeded
scripts/EscapeDisallowedHtmlTags.ps1 ✅Succeeded
scripts/GenerateAliasedDocs.ps1 ✅Succeeded
scripts/GenerateMarkDown.ps1 ✅Succeeded
scripts/GeneratePermissionsTable.ps1 ✅Succeeded
scripts/MsSubserviceUpdate.ps1 ✅Succeeded
scripts/RemoveBoilerPlateCode.ps1 ✅Succeeded
scripts/RemoveInvalidFullStops.ps1 ✅Succeeded
scripts/RepairExamplesDescriptionsAndTitle.ps1 ✅Succeeded
scripts/UpdateLinks.ps1 ✅Succeeded

For more details, please refer to the build report.

In the split pipeline each profile stage generates a single profile, so a post-processing step can legitimately produce no changes for that profile. A bare 'git commit' exits 1 ('nothing to commit') and, as the last native command in the step, fails the task even though nothing is wrong. Apply the 'commit only if staged changes exist' guard (already present in CorrectRelatedLinks/UpdateLinks/MsSubserviceUpdate) to the remaining scripts: GenerateMarkDown, EscapeDisallowedHtmlTags, GeneratePermissionsTable, RemoveBoilerPlateCode, RemoveInvalidFullStops, RepairExamplesDescriptionsAndTitle.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot-Session: 4d27d82f-3809-40d2-b4e7-6623436ff2ef
@learn-build-service-prod

Copy link
Copy Markdown
Contributor

PoliCheck Scan Report

The following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 and severity-2 issues. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans.

✅ No issues found

More information about PoliCheck

Information: PoliCheck | Severity Guidance | Term
For any questions: Try searching the learn.microsoft.com contributor guides or post your question in the Learn support channel.

@learn-build-service-prod

Copy link
Copy Markdown
Contributor

Learn Build status updates of commit d4725c2:

✅ Validation status: passed

File Status Preview URL Details
azure-pipelines/common-templates/generate-docs-steps.yml ✅Succeeded
azure-pipelines/powershell-docs.yml ✅Succeeded
scripts/CorrectRelatedLinks-AllFiles.ps1 ✅Succeeded
scripts/EscapeDisallowedHtmlTags.ps1 ✅Succeeded
scripts/GenerateAliasedDocs.ps1 ✅Succeeded
scripts/GenerateMarkDown.ps1 ✅Succeeded
scripts/GeneratePermissionsTable.ps1 ✅Succeeded
scripts/MsSubserviceUpdate.ps1 ✅Succeeded
scripts/RemoveBoilerPlateCode.ps1 ✅Succeeded
scripts/RemoveInvalidFullStops.ps1 ✅Succeeded
scripts/RepairExamplesDescriptionsAndTitle.ps1 ✅Succeeded
scripts/UpdateLinks.ps1 ✅Succeeded

For more details, please refer to the build report.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant