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

add docs_build step #1189

Merged
merged 14 commits into from
Jan 18, 2023
Merged

add docs_build step #1189

merged 14 commits into from
Jan 18, 2023

Conversation

AyodeAwe
Copy link
Contributor

The PR adds a docs_build process to the PR and Build workflows for this repository. The generated docs are synced to s3 for only the build workflows.

@AyodeAwe AyodeAwe requested a review from a team as a code owner January 13, 2023 17:04
@github-actions github-actions bot added the ci label Jan 13, 2023
@AyodeAwe AyodeAwe force-pushed the add-docs-build branch 2 times, most recently from 87bd312 to 44c6729 Compare January 13, 2023 17:37
@codecov-commenter
Copy link

codecov-commenter commented Jan 13, 2023

Codecov Report

Base: 0.00% // Head: 0.00% // No change to project coverage 👍

Coverage data is based on head (dc84bc2) compared to base (4e6716d).
Patch has no changes to coverable lines.

Additional details and impacted files
@@             Coverage Diff              @@
##           branch-23.02   #1189   +/-   ##
============================================
  Coverage          0.00%   0.00%           
============================================
  Files                 6       6           
  Lines               421     421           
============================================
  Misses              421     421           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@AyodeAwe AyodeAwe force-pushed the add-docs-build branch 2 times, most recently from ca77e8d to ce9ea0f Compare January 13, 2023 19:13
dependencies.yaml Outdated Show resolved Hide resolved
dependencies.yaml Outdated Show resolved Hide resolved
.github/workflows/pr.yaml Outdated Show resolved Hide resolved
dependencies.yaml Outdated Show resolved Hide resolved
@AyodeAwe AyodeAwe added non-breaking Non-breaking change improvement Improvement / enhancement to an existing function labels Jan 17, 2023
Copy link
Member

@ajschmidt8 ajschmidt8 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

few changes suggested

.github/workflows/build.yaml Outdated Show resolved Hide resolved
ci/build_docs.sh Outdated Show resolved Hide resolved
ci/build_docs.sh Show resolved Hide resolved
ci/build_docs.sh Outdated Show resolved Hide resolved
ci/build_docs.sh Outdated Show resolved Hide resolved
ci/build_docs.sh Outdated Show resolved Hide resolved
.github/workflows/build.yaml Outdated Show resolved Hide resolved
ci/build_docs.sh Outdated Show resolved Hide resolved
ci/build_docs.sh Outdated Show resolved Hide resolved
AyodeAwe and others added 3 commits January 18, 2023 09:17
Co-authored-by: AJ Schmidt <ajschmidt8@users.noreply.github.com>
Co-authored-by: AJ Schmidt <ajschmidt8@users.noreply.github.com>
Co-authored-by: AJ Schmidt <ajschmidt8@users.noreply.github.com>
@ajschmidt8
Copy link
Member

ajschmidt8 commented Jan 18, 2023

The scripts look okay now, but the logs are showing some error codes.

I'm not sure why these aren't causing the job to fail. It's possible that the doxygen command is still exiting with 0 despite these errors.

Regardless, we should investigate and try to get them fixed.

The entire job log should be scanned for additional error messages besides the ones explicitly shown below.

image

ci/build_docs.sh Outdated Show resolved Hide resolved
ci/build_docs.sh Outdated Show resolved Hide resolved
dependencies.yaml Outdated Show resolved Hide resolved
dependencies.yaml Outdated Show resolved Hide resolved
@github-actions github-actions bot added the cpp Pertains to C++ code label Jan 18, 2023
Copy link
Contributor

@bdice bdice left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome! All looks good to me.

Two follow-up tasks for developers to address in separate PRs:

@ajschmidt8
Copy link
Member

/merge

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci cpp Pertains to C++ code improvement Improvement / enhancement to an existing function non-breaking Non-breaking change
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

4 participants