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

Prevent docs gen workflow on forks #6390

Merged
merged 2 commits into from
Dec 6, 2022
Merged

Conversation

stu-k
Copy link
Contributor

@stu-k stu-k commented Dec 6, 2022

resolves #6386

Description

Adds a conditional to the check_gen step of the CLI API doc gen workflow to prevent being run off of forks. Tested on a fork:
Screen Shot 2022-12-06 at 9 38 05 AM

Checklist

@stu-k stu-k requested review from emmyoop and leahwicz December 6, 2022 15:39
@cla-bot cla-bot bot added the cla:yes label Dec 6, 2022
@github-actions
Copy link
Contributor

github-actions bot commented Dec 6, 2022

Thank you for your pull request! We could not find a changelog entry for this change. For details on how to document a change, see the contributing guide.

@stu-k stu-k requested a review from a team as a code owner December 6, 2022 15:40
Copy link
Contributor

@dbeatty10 dbeatty10 left a comment

Choose a reason for hiding this comment

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

Awesome, @stu-k ! 💪

Thanks for the screenshot -- made it easy to see it working 🧠

Approving this proactively assuming that all CI tests will pass.

Copy link
Member

@emmyoop emmyoop left a comment

Choose a reason for hiding this comment

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

Looks good - just remove the changelog before merging!

Comment on lines +1 to +7
kind: Under the Hood
body: Prevent doc gen workflow from running on forks
time: 2022-12-06T09:40:15.301984-06:00
custom:
Author: stu-k
Issue: "6386"
PR: "6390"
Copy link
Member

Choose a reason for hiding this comment

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

This change doesn't need a changelog since it's not something actually released.

@stu-k stu-k merged commit 540c3b7 into main Dec 6, 2022
@stu-k stu-k deleted the CT-1609/prevent-action-on-forks branch December 6, 2022 17:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[CT-1609] [Bug] Generate CLI API docs CI check not able to checkout PR branches from forks
3 participants