OpenPublishing.Build fails on every PR: monikerMapping.json packageRoot is missing the docs/ prefix
Chưa có ai nhận issue này.
Đánh giá
- Độ khó
- 2/5
- Thời gian dự kiến
- 1-3 giờ
- Mức phù hợp với người mới
- 55/100
- Loại issue
- Lỗi
- Độ rõ ràng
- Đặc tả rõ ràng
- Mức độ hoạt động
- Sôi nổi
- Công nghệ
- github-actions, json, powershell
- Lĩnh vực
- ci-cd, documentation
Hướng nghiên cứu
Read .openpublishing.publish.config.json and module/mapping/monikerMapping.json, then verify the referenced paths against the contents of module/docs/. Check both preview monikers and confirm the expected path fields with a maintainer who can run the OpenPublishing validation build. Done means the build passes for a PR, including one that does not change documentation.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
Every open pull request in this repository currently shows OpenPublishing.Build as failed with the same validation error, including ones that touch no documentation at all:
[Error: PSMD2Yaml_FileLoadFailed] Failed to load file: <...>/module/mapping/monikerMapping.json.
PackageRoot, ReferenceTocUrl, and ConceptualTocUrl are required for every moniker.
PackageRoot should be a valid relative path to docset root.
Confirmed red on #1601, #1572, #1529 and #1611 (and #1611 reproduced it on two different commits, which rules out the branch contents).
Root cause
All three required keys are in fact present in module/mapping/monikerMapping.json, so the first sentence of the error is a red herring. The operative part is the second one: packageRoot is not a valid relative path to the docset root.
.openpublishing.publish.config.json sets "build_source_folder": "module", so the docset root is module/. The mapping declares:
"entra-powershell-preview": {
"packageRoot": "entra-powershell-v1.0",
"conceptualToc": "docs/entra-powershell-v1.0/toc.yml",
...
}
module/entra-powershell-v1.0 does not exist. The contents of module/ are breadcrumb, docfx.json, docs, Entra, EntraBeta and mapping. The reference markdown actually lives in module/docs/entra-powershell-v1.0/ (Applications/, Authentication/, Enable-EntraAzureADAlias.md, ...), which relative to the docset root is docs/entra-powershell-v1.0.
The inconsistency is visible inside the same JSON object: conceptualToc carries the docs/ prefix and packageRoot does not. The same mismatch exists for entra-powershell-beta-preview.
Why it started
module/mapping/monikerMapping.json has not been modified since bfeb177 (2024-03-12, "Update structure"). The module/docs/entra-powershell-v1.0 path has existed since at least 846f29c (2024-09-29). The mapping was written against the earlier layout and was not updated when the docs moved under module/docs/.
Suggested fix
Adding the prefix to both monikers would make the paths resolve:
"entra-powershell-preview": { "packageRoot": "docs/entra-powershell-v1.0", ... }
"entra-powershell-beta-preview": { "packageRoot": "docs/entra-powershell-beta", ... }
I am deliberately filing this as an issue rather than a pull request: OpenPublishing runs inside Microsoft infrastructure, so I cannot execute the docs build to confirm the fix, and getting the docset layout wrong would affect published documentation. Someone who can trigger a validation build is better placed to confirm whether the prefix is the whole story or whether referenceTocUrl and conceptualTocUrl need adjusting alongside it.
Happy to open the PR if a maintainer confirms the direction.
Impact
While this is red, OpenPublishing.Build is not a usable signal on any PR: contributors cannot tell a real documentation regression from the pre-existing failure, and PRs that are otherwise ready carry a red check. #1611 is approved and blocked behind exactly this noise.
- Ngôn ngữ chính
- PowerShell
- Star
- 218
- Fork
- 48
- Chỉ số merge pull request
- Không có pull request nào được merge trong 30 ngày
Chuẩn bị môi trường
- Không có Dockerfile hay tệp Docker Compose
- Không có mẫu pull request
- Đọc hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Issue khác của microsoftgraph/entra-powershell
-
ToTriage
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 55/100
microsoftgraph/entra-powershell#1617 ·
-
🪲 unable to connect to entra: InvalidOperation: Unable to find type [Microsoft.Graph.PowerShell.Authentication.ContextScope].Có thể đã có người làm @Mike-Crowley đã nhận 36 ngày trước. Đang mởToTriage
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 55/100
microsoftgraph/entra-powershell#1614 · 4 bình luận ·
-
🪲 Characters 0xE2 0x80 0xAF presented in date time signInActivity property when expanded on MacOSĐang mởToTriage
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 55/100
microsoftgraph/entra-powershell#1605 ·
-
🪲 Import-Module Microsoft.Entra.Applications / Microsoft.Entra..Beta.Applications throws an error 1.3.0Có thể đã có người làm @earbona23 đã nhận 78 ngày trước. Đang mởToTriage
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 45/100
microsoftgraph/entra-powershell#1603 · 2 bình luận · 2 reaction ·
-
🪲EntraInactiveSignInUser Days LimitationCó thể đã có người làm @reneemichiko đã nhận 189 ngày trước. Đang mởdocumentation
microsoftgraph/entra-powershell#1596 · 1 bình luận · 1 reaction · 2 người được giao ·
Tất cả issue của microsoftgraph/entra-powershell
Issue tương tự
-
Docker images: plain X.Y.Z tag (e.g. 7.2.3) is never updated after the initial release buildĐang mởneeds verification
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 74/100
Maintainer thường phản hồi trong vòng 13 ngày
-
bug
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
Azure/enterprise-azure-policy-as-code#1463 ·
Maintainer thường phản hồi trong vòng 2 ngày
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 82/100
ipfs/ipfs-webui#2507 ·
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 72/100
bigbluebutton/bigbluebutton#26638 · 1 bình luận ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 66/100