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.

Sign up for GitHub

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

Jump to bottom

ci: Raise Documentation Generation Errors #7559

Merged
merged 3 commits into from
Aug 22, 2024
Merged

ci: Raise Documentation Generation Errors #7559

merged 3 commits into from
Aug 22, 2024

Conversation

fpetrini15
Copy link
Contributor

@fpetrini15 fpetrini15 commented Aug 21, 2024 •
edited
Loading

What does the PR do?

Raise errors in the documentation generation script so that CI doesn't falsely report that the job succeeded

Checklist

  • PR title reflects the change and is of format <commit_type>: <Title>
  • Changes are described in the pull request.
  • Related issues are referenced.
  • Populated github labels field
  • Added test plan and verified test passes.
  • Verified that the PR passes existing CI.
  • Verified copyright is correct on all changed files.
  • Added succinct git squash message before merging ref.
  • All template sections are filled out.

Commit Type:

Check the conventional commit type
box here and add the label to the github PR.

  • build
  • ci
  • docs
  • feat
  • fix
  • perf
  • refactor
  • revert
  • style
  • test

@fpetrini15 fpetrini15 added the PR: ci Changes to our CI configuration files and scripts label Aug 21, 2024
@mc-nv mc-nv self-requested a review August 21, 2024 23:52
mc-nv
mc-nv previously approved these changes Aug 21, 2024
View reviewed changes
yinggeh
yinggeh requested changes Aug 22, 2024
View reviewed changes
docs/generate_docs.py Show resolved Hide resolved
@yinggeh
Copy link
Contributor

yinggeh commented Aug 22, 2024

In get_git_repo_name, catch statement should raise error instead of return None. Can you also fix that?

@fpetrini15 fpetrini15 merged commit fb60c0e into main Aug 22, 2024
3 checks passed
@fpetrini15 fpetrini15 deleted the fpetrini-catch-doc-gen-errors branch August 22, 2024 17:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@yinggeh yinggeh yinggeh approved these changes

@mc-nv mc-nv mc-nv left review comments

Assignees
No one assigned
Labels
PR: ci Changes to our CI configuration files and scripts
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@fpetrini15 @yinggeh @mc-nv