Skip to content

Route top-level docs through lightweight PR validation - #50386

Open
vcolin7 wants to merge 10 commits into
mainfrom
vcolin7/exclude-static-docs-paths
Open

Route top-level docs through lightweight PR validation#50386
vcolin7 wants to merge 10 commits into
mainfrom
vcolin7/exclude-static-docs-paths

Conversation

@vcolin7

@vcolin7 vcolin7 commented Sep 9, 2026

Copy link
Copy Markdown
Member

Description

  • Removes the duplicate CSpell step from Analyze.
  • Excludes changes limited to docs/** from java - pullrequest.
  • Keeps docs/ out of package selection for mixed PRs.
  • Removes the unused restapi* and pipelinev3* target branch patterns.
  • Uses Node 24 for spelling validation.
  • Adds tests for spelling-workflow branch parity, trigger exclusions, and the reviewed docs/** file types.

Motivation

PR #50302 prevents documentation-only changes from creating Java test matrices, but Build and Analyze still run.

PR #50383 added independent spelling validation. This change routes the top-level docs/** tree through that required lightweight check so those changes can avoid the Java pipeline entirely.

Validation

  • Pester 5.7.1: 52 tests passed.
  • actionlint 1.7.12 passed.
  • GitHub Actions and Azure Pipelines YAML parsed successfully.
  • Changed-file CSpell passed.
  • git diff --check passed.
  • The final diff contains no eng/common changes or centrally synchronized workflow changes.

Rollout

The rollout prerequisites are complete:

  1. Add lightweight pull request spelling validation #50383 is merged.
  2. Check Spelling is required by the repository ruleset.
  3. Draft PR Add test comment for GitHub actions check #50423 confirmed that a failing spelling check blocks merging.

Scope

This change excludes only docs/**.

Root documentation and legal files remain on the existing classifier path because exact-file ExcludePaths matching requires an upstream Azure/azure-sdk-tools change. Package README, CHANGELOG, SAMPLE, and TROUBLESHOOTING files also remain on the classifier path.

The centrally synchronized Verify Links workflow remains unchanged. No blanket Markdown or text-file exclusions are added.

Written with the help of vcolin7-copilot.

@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines:
36 pipeline(s) were filtered out due to trigger conditions.
There may be pipelines that require an authorized user to comment /azp run to run.

@vcolin7
vcolin7 added this pull request to stack #50387 September 9, 2026 06:56
Expand link validation to every Java PR target branch, remove the duplicate
Analyze spelling step, and exclude only docs/** from the Azure PR pipeline.
Keep root and package documentation on the existing classifier path.
Copilot AI lite review requested due to automatic review settings September 9, 2026 06:59
@vcolin7
vcolin7 force-pushed the vcolin7/exclude-static-docs-paths branch from 1b67a9f to c708870 Compare September 9, 2026 06:59

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

The trigger/exclusion changes are narrowly scoped, aligned across pipelines/workflows, and backed by targeted Pester tests that enforce the intended contracts.

Pull request overview

This PR routes docs/**-only pull requests away from the heavyweight Azure Pipelines java - pullrequest validation and through lightweight GitHub Actions checks (spelling + link verification), while keeping mixed PR behavior stable via explicit classifier exclusions and regression tests.

Changes:

  • Excludes docs/**-only changes from the Azure Pipelines PR trigger and also excludes docs/ from package selection for mixed PRs.
  • Expands the Verify Links GitHub Actions workflow branch filters to match the java - pullrequest target branches.
  • Removes the duplicate CSpell step from the Azure Pipelines Analyze job and adds Pester tests to enforce branch parity and exclusion contracts.
File summaries
File Description
eng/scripts/tests/PullRequest-Trigger.tests.ps1 Adds Pester coverage to lock in PR trigger exclusions, workflow branch parity, and reviewed docs/** file-type invariants.
eng/pipelines/templates/jobs/ci.yml Removes the duplicated Azure Pipelines spelling step from Analyze (spelling is now handled via a dedicated GitHub Actions workflow).
eng/pipelines/pullrequest.yml Excludes docs/** from the PR trigger and adds docs/ to ExcludePaths to keep docs out of mixed-PR package selection.
.github/workflows/verify-links.yml Aligns workflow PR branch filters with the Azure Pipelines java - pullrequest branch set.
Review details
  • Files reviewed: 4/4 changed files
  • Comments generated: 0
  • Review effort level: Lite

💡 Add a code-review agent skill for context-aware, tailored reviews. Learn more in the docs.

Comment thread .github/workflows/verify-links.yml Outdated
@vcolin7

vcolin7 commented Sep 11, 2026

Copy link
Copy Markdown
Member Author

We can go ahead with this PR. We recently enabled the Check Spelling GitHub action as a required check, as shown in this draft PR.

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.

3 participants