Disallow edits on System.Text.RegularExpressions docs#12529
Disallow edits on System.Text.RegularExpressions docs#12529gewarren merged 1 commit intodotnet:mainfrom
Conversation
The source of truth for System.Text.RegularExpressions XML docs is being moved to dotnet/runtime (see dotnet/runtime#127038). - Add System.Text.RegularExpressions to disallow-edits.yml GitOps policy - Set open_to_public_contributors to false in docfx.json Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
github-actions
bot
added
the
needs-area-label
|
@gewarren is this correct? and note the question about sharepoint |
There was a problem hiding this comment.
Pull request overview
This PR updates repository governance and DocFX metadata to prevent direct edits to System.Text.RegularExpressions API reference content in this repo, aligning with the move of the source-of-truth docs to /// comments in dotnet/runtime.
Changes:
- Disallows PR edits to
xml/System.Text.RegularExpressions/*via GitOps policy (auto-close on PR open). - Hides the “Edit” button for
System.Text.RegularExpressionsAPI pages by settingopen_to_public_contributorstofalsein DocFX metadata.
Show a summary per file
| File | Description |
|---|---|
docfx.json |
Marks api/System.Text.RegularExpressions.** as not open to public contributors to disable editing on published pages. |
.github/policies/disallow-edits.yml |
Adds xml/System.Text.RegularExpressions/* to the set of paths that trigger the auto-close policy for PRs editing out-of-repo source-of-truth docs. |
Copilot's findings
- Files reviewed: 2/2 changed files
- Comments generated: 0
|
@gewarren note the other PR isn't merged yet. It should happen today - it got stuck |
|
And I'm still curious -- is a 3rd flag needed -- to say "use XML file to populate content here" -- or does one of the flags set in this PR do that |
Yes, a third flag is needed, but I'll take care of it in dotnet/docs-tools#662. This repo isn't consulted during the ingestion of DLLs/XML files when the CI is run. |
|
OK Pr was merged on other side |
Note
This PR description was AI/Copilot-generated.
Follow-up to dotnet/runtime#127038, which backports
System.Text.RegularExpressionsXML docs to///comments in dotnet/runtime source.Important
Do not merge until dotnet/runtime#127038 merges.
Changes
disallow-edits.yml: Addxml/System.Text.RegularExpressions/*to the GitOps policy that auto-closes PRs modifying files whose source of truth is in dotnet/runtime.docfx.json: Setopen_to_public_contributorstofalseforapi/System.Text.RegularExpressions.**to hide the Edit button on learn.microsoft.com.Remaining follow-up
Per #10722, since
System.Text.RegularExpressionsships as part of the shared framework, it should also be added to the docs CI pipeline for ongoing validation (the list of XML files to push to the binaries repo). That step requires access to an internal SharePoint document and should be handled separately.Fixes part of #10722