-
Notifications
You must be signed in to change notification settings - Fork 932
DocFX sanity check #742
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
DocFX sanity check #742
Conversation
| - name: check out code | ||
| uses: actions/checkout@v2 | ||
|
|
||
| - name: install docfx |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why do you install it, if it is already checked into source control?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The tool is not checked into source control.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What is docfx.cmd file below then?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A wrapper script to run docfx with the right options & exit code? https://github.com/open-telemetry/opentelemetry-specification/pull/742/files#diff-2fa7a6d21c1369efbff0a5d848afef7a
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes @Oberon00 is correct, it is a wrapper script to run docfx.exe.
Changes
Added DocFx sanity check to the CI.
Fixed all the broken links.
Once this PR gets merged, no one is going to introduce broken link again.