CHANGE: docs tools update - #2460
Conversation
![u-pr[bot]](https://avatars.githubusercontent.com/in/1201017?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Harness Review
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.
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 ReportAll modified and coverable lines are covered by tests ✅ @@ Coverage Diff @@
## develop #2460 +/- ##
===========================================
- Coverage 78.95% 78.95% -0.01%
===========================================
Files 767 767
Lines 140780 140811 +31
===========================================
+ Hits 111153 111175 +22
- Misses 29627 29636 +9 Flags with carried forward coverage won't be shown. Click here to find out more.
|
jfreire-unity
left a comment
jfreire-unity
left a comment
There was a problem hiding this comment.
The change looks like it upgrades the PMDT but CI still fails, so we should circle back to the docs engineering team and let us know it's not fixing the problem.
Also, have you tried locally if this change generates the documentation?
…logies/InputSystem into update-docs-tooling
|
/review |
There was a problem hiding this comment.
💡 Harness Review
The generated test recipes are now synchronized with the updated tooling commands, but the Wrench package registration introduces a broken package-pack target.
Registering com.unity.package-manager-doctools as a Wrench package also generates package_pack_-_package-manager-doctools, whose only pack command targets Packages/com.unity.package-manager-doctools. That directory is not present in this checkout—the test recipes create it only in their own CI jobs via git clone—so invoking this newly published Yamato package-pack job fails immediately on a nonexistent path. Either omit the transient doctools clone from Wrench's package list or add a clone/setup command to the generated pack job.
Reviewed commit cd2618c
🤖 Helpful? 👍/👎
2 participants
Description
Upgrading docs package tools. DocFX is no longer part of the package and needs to be installed separately.
Also the .csproj file creation is not handled by the docs package anymore, so I included a command that creates the project files via the rider package.
Additionally I added a small format fix in Packages/com.unity.inputsystem/Documentation~/built-in-interactions.md.
Testing status & QA
None.
Overall Product Risks
Comments to reviewers
Checklist
Before review:
Changed,Fixed,Addedsections.Area_CanDoX,Area_CanDoX_EvenIfYIsTheCase,Area_WhenIDoX_AndYHappens_ThisIsTheResult.During merge:
NEW: ___.FIX: ___.DOCS: ___.CHANGE: ___.RELEASE: 1.1.0-preview.3.