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

Add build check on PR #11

Merged
merged 1 commit into from
Mar 6, 2024
Merged

Add build check on PR #11

merged 1 commit into from
Mar 6, 2024

Conversation

rollandf
Copy link
Member

@rollandf rollandf commented Mar 6, 2024

Fix #10

@rollandf
Add build check on PR
8cdb51a 
Signed-off-by: Fred Rolland <frolland@nvidia.com>
ykulazhenkov
ykulazhenkov reviewed Mar 6, 2024
View reviewed changes
.github/workflows/build.yaml
- name: checkout
uses: actions/checkout@v4
- name: build
run: ./repo.sh docs
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe we can improve this job to store generated docs as a build artifact?

Copy link
Member Author

Choose a reason for hiding this comment

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

Sure, any suggestion?
Should it be in same PR or follow up?

Copy link
Contributor

Choose a reason for hiding this comment

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

here is the example how to achieve this with gh actions https://docs.github.com/en/actions/using-workflows/storing-workflow-data-as-artifacts#example.
Not a blocker for to this PR

Copy link
Member Author

Choose a reason for hiding this comment

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

Let's handle it as part of #5

@killianmuldoon
Copy link
Contributor

How can I make this fail?

@rollandf
Copy link
Member Author

rollandf commented Mar 6, 2024

How can I make this fail?

For example:

[ERROR] Documentation build failed.
Errors (from: '/home/frolland/git/network-operator-docs/_build/docs/sphinx_warnings.txt'):
/home/frolland/git/network-operator-docs/docs/device-plugin.rst:20: WARNING: Title overline too short.

**********
Device Plugin
**********

@killianmuldoon
Copy link
Contributor

/lgtm

@rollandf rollandf merged commit ada32df into Mellanox:main Mar 6, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ykulazhenkov ykulazhenkov ykulazhenkov left review comments

@killianmuldoon killianmuldoon killianmuldoon approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add build check on PR
3 participants
@rollandf @killianmuldoon @ykulazhenkov