Skip to content

Split docs generation pipeline into v1.0 and beta stages#820

Draft
ramsessanchez wants to merge 5 commits into
mainfrom
split-pipeline-v1-beta
Draft

Split docs generation pipeline into v1.0 and beta stages#820
ramsessanchez wants to merge 5 commits into
mainfrom
split-pipeline-v1-beta

Conversation

@ramsessanchez

Copy link
Copy Markdown
Contributor

Summary

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

  • v1 stage generates the v1.0 docs (including the Microsoft.Graph.Authentication module), post-processes, pushes WeeklyReferenceDocsUpdate-v1.0_*, and opens its own PR.
  • beta stage does the same, scoped to beta, on its own branch and PR.
  • Stages run independently (dependsOn: []) on fresh agents; artifacts are suffixed per profile (MissingExternalDocs-v1.0 / -beta).

Changes

  • New reusable steps template azure-pipelines/common-templates/generate-docs-steps.yml parameterized by GraphProfile, branch prefix, and PR title/body.
  • azure-pipelines/powershell-docs.yml restructured into the v1 and beta stages.
  • Added a -GraphProfile (v1.0/beta/both, default both) parameter to the generation/post-processing scripts so each stage only touches its profile. Authentication generation/cleanup runs only in the v1.0 path.

Validation

  • All modified PowerShell scripts pass the PS parser.
  • Both pipeline YAML files parse cleanly.
  • Backward compatible: scripts default to both when run manually.

Microsoft Graph DevX Tooling and others added 4 commits July 22, 2026 13:38
Each stage now generates, post-processes, pushes, and opens its own PR for
its profile. Authentication (Microsoft.Graph.Authentication) is regenerated
as part of the v1.0 stage. All generation/post-processing scripts accept a
-GraphProfile (v1.0/beta/both) parameter to scope their work.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot-Session: e654e00b-3fad-4d5b-8d51-16a0238a08be
@ramsessanchez
ramsessanchez marked this pull request as draft July 22, 2026 22:59
@ramsessanchez
ramsessanchez changed the base branch from ramsess/revert-generation-changes to main July 22, 2026 22:59
@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.

1 similar comment
@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 a9599fe:

✅ Validation status: passed

File Status Preview URL Details
azure-pipelines/common-templates/generate-docs-steps.yml ✅Succeeded
azure-pipelines/powershell-docs.yml ✅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.

Per-profile stages frequently produce no changes for a given post-processing
step. An unconditional 'git commit' returns exit code 1 on an empty diff,
which failed the 'Generate permissions table' task. Commit only when there
are staged changes, matching the existing guard in UpdateLinks/MsSubserviceUpdate.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot-Session: e654e00b-3fad-4d5b-8d51-16a0238a08be
@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 a9599fe:

✅ Validation status: passed

File Status Preview URL Details
azure-pipelines/common-templates/generate-docs-steps.yml ✅Succeeded
azure-pipelines/powershell-docs.yml ✅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.

@learn-build-service-prod

Copy link
Copy Markdown
Contributor

Learn Build status updates of commit ade01f7:

✅ Validation status: passed

File Status Preview URL Details
azure-pipelines/common-templates/generate-docs-steps.yml ✅Succeeded
azure-pipelines/powershell-docs.yml ✅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