Skip to content

CHANGE: docs tools update - #2460

Open
ritamerkl wants to merge 2 commits into
developfrom
update-docs-tooling
Open

CHANGE: docs tools update#2460
ritamerkl wants to merge 2 commits into
developfrom
update-docs-tooling

Conversation

@ritamerkl

Copy link
Copy Markdown
Collaborator

Description

Upgrading docs package tools. DocFX is no longer part of the package and needs to be installed separately.

Testing status & QA

None.

Overall Product Risks

  • Complexity: Low
  • Halo Effect: Low

Comments to reviewers

Checklist

Before review:

  • Changelog entry added.
    • Explains the change in Changed, Fixed, Added sections.
    • For API change contains an example snippet and/or migration example.
    • JIRA ticket linked, example (case %%). If it is a private issue, just add the case ID without a link.
    • Jira port for the next release set as "Resolved".
  • Tests added/changed, if applicable.
    • Functional tests Area_CanDoX, Area_CanDoX_EvenIfYIsTheCase, Area_WhenIDoX_AndYHappens_ThisIsTheResult.
    • Performance tests.
    • Integration tests.
  • Docs for new/changed API's.
    • Xmldoc cross references are set correctly.
    • Added explanation how the API works.
    • Usage code examples added.
    • The manual is updated, if needed.

During merge:

  • Commit message for squash-merge is prefixed with one of the list:
    • NEW: ___.
    • FIX: ___.
    • DOCS: ___.
    • CHANGE: ___.
    • RELEASE: 1.1.0-preview.3.

@u-pr u-pr Bot 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.

💡 Harness Review

Needs changes

The recipe source update is directionally fine, but the checked-in Yamato configuration has not been regenerated, so the CI jobs this repository actually runs still use the old docs tooling.

P1

The recipe changes here do not take effect until the generated .yamato/input-system-*.yml files are refreshed and committed. The checked-in job definitions that Yamato consumes still contain the old commands (git clone --branch "2.3.0-preview" ... everywhere, plus %GSUDO% choco install netfx-4.7.1-devpack ... on Windows; see .yamato/input-system-editor-functional-tests.yml / .yamato/input-system-standalone-functional-tests.yml), and .yamato/triggers.yml points at those generated files directly. As committed, this PR will merge without actually switching CI to PMDT 3.14 or installing DocFX 2.70 anywhere. Please regenerate the job YAML and include the updated .yamato/input-system-*.yml outputs in the PR.

Reviewed commit 7efc128

🤖 Helpful? 👍/👎

@codecov-github-com

codecov-github-com Bot commented Jul 29, 2026

Copy link
Copy Markdown

Codecov Report

All modified and coverable lines are covered by tests ✅

@@           Coverage Diff            @@
##           develop    #2460   +/-   ##
========================================
  Coverage    78.95%   78.95%           
========================================
  Files          767      767           
  Lines       140780   140780           
========================================
  Hits        111153   111153           
  Misses       29627    29627           
Flag Coverage Δ
inputsystem_MacOS_6000.0 5.31% <ø> (ø)
inputsystem_MacOS_6000.0_project 77.49% <ø> (ø)
inputsystem_MacOS_6000.3 5.31% <ø> (ø)
inputsystem_MacOS_6000.3_project 77.49% <ø> (+<0.01%) ⬆️
inputsystem_MacOS_6000.5 5.30% <ø> (ø)
inputsystem_MacOS_6000.5_project 77.55% <ø> (ø)
inputsystem_MacOS_6000.6 5.30% <ø> (ø)
inputsystem_MacOS_6000.6_project 77.55% <ø> (-0.01%) ⬇️
inputsystem_MacOS_6000.7 5.30% <ø> (ø)
inputsystem_MacOS_6000.7_project 77.55% <ø> (ø)
inputsystem_Ubuntu_6000.0 5.31% <ø> (ø)
inputsystem_Ubuntu_6000.0_project 77.40% <ø> (ø)
inputsystem_Ubuntu_6000.3 5.31% <ø> (ø)
inputsystem_Ubuntu_6000.3_project 77.40% <ø> (+<0.01%) ⬆️
inputsystem_Ubuntu_6000.5 5.30% <ø> (ø)
inputsystem_Ubuntu_6000.5_project 77.46% <ø> (+<0.01%) ⬆️
inputsystem_Ubuntu_6000.6 5.30% <ø> (ø)
inputsystem_Ubuntu_6000.6_project 77.46% <ø> (ø)
inputsystem_Ubuntu_6000.7 5.30% <ø> (ø)
inputsystem_Ubuntu_6000.7_project 77.46% <ø> (ø)
inputsystem_Windows_6000.0 5.31% <ø> (ø)
inputsystem_Windows_6000.0_project 77.56% <ø> (ø)
inputsystem_Windows_6000.3 5.31% <ø> (ø)
inputsystem_Windows_6000.3_project 77.56% <ø> (-0.01%) ⬇️
inputsystem_Windows_6000.5 5.30% <ø> (ø)
inputsystem_Windows_6000.5_project 77.62% <ø> (ø)
inputsystem_Windows_6000.6 5.30% <ø> (ø)
inputsystem_Windows_6000.6_project 77.62% <ø> (ø)
inputsystem_Windows_6000.7 5.30% <ø> (ø)
inputsystem_Windows_6000.7_project 77.62% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

ℹ️ Need help interpreting these results?

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