Skip to content

fix: use full semver in release notes filenames#10855

Merged
VesaJuvonen merged 1 commit into
SharePoint:mainfrom
garrytrinder:ax/release-notes-semver
May 21, 2026
Merged

fix: use full semver in release notes filenames#10855
VesaJuvonen merged 1 commit into
SharePoint:mainfrom
garrytrinder:ax/release-notes-semver

Conversation

@garrytrinder
Copy link
Copy Markdown
Contributor

Summary

Renames 17 SPFx release notes files from release-1.X.md to release-1.X.0.md to use explicit semantic versioning (e.g., release-1.22.mdrelease-1.22.0.md).

Why

AI coding agents that help developers upgrade SPFx projects rely on release notes filenames to locate version-specific documentation. When a file is named release-1.22.md rather than release-1.22.0.md, agents don't recognise it as the 1.22.0 release and skip it — even though it contains the exact information they need.

In benchmark testing, agents failed to fetch the correct release notes in 4 out of 5 runs. After simulating the semver filename change, agents fetched the right docs in 5 out of 5 runs.

Changes

  • 17 files renamed from release-1.X.mdrelease-1.X.0.md (versions: 1.1, 1.3–1.7, 1.13–1.23)
  • File content updated — version references within each file now use full semver
  • TOC updateddocs/toc.yml name and href entries updated
  • 17 redirect entries added to .openpublishing.redirection.json for old URLs
  • 2 existing redirect targets updated (pointed to release-1.14)
  • ~40 cross-references updated across 22 files

No breaking changes

  • Redirect entries ensure old URLs continue to work
  • Existing patch version files (e.g., release-1.22.1.md, release-1.17.4.md) are untouched
  • Display text in cross-references is preserved; only link targets updated

Rename 17 release notes files from release-1.X.md to release-1.X.0.md
to use explicit semantic versioning. This helps AI coding agents
identify the correct version-specific documentation when upgrading
SPFx projects.

Changes:
- Renamed 17 files (1.1, 1.3-1.7, 1.13-1.23)
- Updated version references within each renamed file
- Updated TOC entries (name + href)
- Added 17 redirect entries for old URLs
- Updated 2 existing redirect targets
- Updated ~40 cross-references across 22 files
@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 b762d3d:

⚠️ Validation status: warnings

File Status Preview URL Details
docs/spfx/release-1.22.0.md ⚠️Warning View Details
docs/spfx/release-1.23.0.md ⚠️Warning View Details
.openpublishing.redirection.json ✅Succeeded View
docs/spfx/compatibility.md ✅Succeeded View
docs/spfx/extensions/basics/tenant-wide-deployment-extensions.md ✅Succeeded View
docs/spfx/extensions/get-started/building-form-customizer.md ✅Succeeded View
docs/spfx/extensions/guidance/list-view-command-set-grouping.md ✅Succeeded View
docs/spfx/integrate-with-teams-introduction.md ✅Succeeded View
docs/spfx/release-1.1.0.md ✅Succeeded View
docs/spfx/release-1.1.md ✅Succeeded n/a (file deleted or renamed)
docs/spfx/release-1.13.0.md ✅Succeeded View
docs/spfx/release-1.13.md ✅Succeeded n/a (file deleted or renamed)
docs/spfx/release-1.14.0.md ✅Succeeded View
docs/spfx/release-1.14.md ✅Succeeded n/a (file deleted or renamed)
docs/spfx/release-1.15.0.md ✅Succeeded View
docs/spfx/release-1.15.md ✅Succeeded n/a (file deleted or renamed)
docs/spfx/release-1.16.0.md ✅Succeeded View
docs/spfx/release-1.16.1.md ✅Succeeded View
docs/spfx/release-1.16.md ✅Succeeded n/a (file deleted or renamed)
docs/spfx/release-1.17.0.md ✅Succeeded View
docs/spfx/release-1.17.1.md ✅Succeeded View
docs/spfx/release-1.17.2.md ✅Succeeded View
docs/spfx/release-1.17.md ✅Succeeded n/a (file deleted or renamed)
docs/spfx/release-1.18.0.md ✅Succeeded View
docs/spfx/release-1.18.md ✅Succeeded n/a (file deleted or renamed)

This comment lists only the first 25 files in the pull request.

docs/spfx/release-1.22.0.md

  • Line 12, Column 3: [Warning: hard-coded-locale - See documentation] Link 'https://learn.microsoft.com/en-us/javascript/api/overview/sharepoint?view=sp-typescript-latest' contains locale code 'en-us'. For localizability, remove 'en-us' from links to most Microsoft sites.
  • Line 12, Column 3: [Suggestion: docs-link-absolute - See documentation] Absolute link 'https://learn.microsoft.com/en-us/javascript/api/overview/sharepoint?view=sp-typescript-latest' will be broken in isolated environments. Replace with a relative link.
  • Line 12, Column 3: [Suggestion: preserve-view-not-set - See documentation] You've pinned this link to a specific version of content with the view parameter. It's recommended not to pin a version unless that version is A) not the default view and B) the context is about that version specifically. To proceed with pinning a version add the &preserve-view=true to the URL. Otherwise, remove the view parameter. URL: https://learn.microsoft.com/en-us/javascript/api/overview/sharepoint?view=sp-typescript-latest

docs/spfx/release-1.23.0.md

  • Line 75, Column 3: [Warning: file-not-found - See documentation] Invalid file link: './viva/get-started/actions/geolocation/geolocationdocumentation'.

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

@VesaJuvonen VesaJuvonen merged commit e19ef64 into SharePoint:main May 21, 2026
3 checks passed
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.

2 participants