Skip to content
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

Fix #623, show stderr output on doc build workflow #625

Merged
merged 1 commit into from
Dec 6, 2022

Conversation

jphickey
Copy link
Contributor

Checklist (Please check before submitting)

Describe the contribution
Tee the stderr output to the console, so if the "Build Documentation" step fails in this workflow, the errors will be visible in the log.

Without this, the errors are hidden in a file that is never shown nor uploaded so it cannot be seen what went wrong.

Fixes #623

Testing performed
Build documentation

Expected behavior changes
If an error occurs, the error will be visible in the workflow run log.

System(s) tested on
Github hosted runner

Additional context
This also makes a minor change to setting the applist to simplify the script and also make it a bit more robust (this does not need to update an existing line, it can just set the value, and thus does not depend on the line already being there to begin with).

Contributor Info - All information REQUIRED for consideration of pull request
Joseph Hickey, Vantage Systems, Inc.

Tee the stderr output to the console, so if the "Build Documentation"
step fails in this workflow, the errors will be visible in the log.

Without this, the errors are hidden in a file that is never shown nor
uploaded so it cannot be seen what went wrong.
@jphickey jphickey added the CCB:Ready Pull request is ready for discussion at the Configuration Control Board (CCB) label Nov 30, 2022
@dzbaker dzbaker added CCB:Approved Indicates code review and approval by community CCB and removed CCB:Ready Pull request is ready for discussion at the Configuration Control Board (CCB) labels Dec 1, 2022
dzbaker added a commit that referenced this pull request Dec 6, 2022
*Combines:*

osal v6.0.0-rc4+dev173
cFE v7.0.0-rc4+dev229

**Includes:**

*cFS*
- #622
- #625
- #626
- #582

*osal*
- nasa/osal#1342
- nasa/osal#1341
- nasa/osal#1321

*cFE*
- nasa/cFE#2215
- nasa/cFE#2219
- nasa/cFE#2217
- nasa/cFE#2222

Co-authored by: Joseph Hickey <jphickey@users.noreply.github.com>
Co-authored by: Daniel Knutsen <dmknutsen@users.noreply.github.com>
Co-authored by: Avi Weiss: <thnkslprpt@users.noreply.github.com>
@dzbaker dzbaker mentioned this pull request Dec 6, 2022
2 tasks
dzbaker added a commit that referenced this pull request Dec 6, 2022
*Combines:*

osal v6.0.0-rc4+dev173
cFE v7.0.0-rc4+dev229

**Includes:**

*cFS*
- #622
- #625
- #626
- #582

*osal*
- nasa/osal#1342
- nasa/osal#1341
- nasa/osal#1321

*cFE*
- nasa/cFE#2215
- nasa/cFE#2219
- nasa/cFE#2217
- nasa/cFE#2222

Co-authored by: Joseph Hickey <jphickey@users.noreply.github.com>
Co-authored by: Daniel Knutsen <dmknutsen@users.noreply.github.com>
Co-authored by: Avi Weiss: <thnkslprpt@users.noreply.github.com>
@dzbaker dzbaker merged commit 8599608 into nasa:main Dec 6, 2022
@jphickey jphickey deleted the fix-623-show-doc-stderr branch April 4, 2023 21:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CCB:Approved Indicates code review and approval by community CCB
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation build does not show errors when it fails
2 participants