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 conditional checks to prevent scheduled actions running inside forked repositories #2317

Merged
merged 5 commits into from
Jan 20, 2024

Conversation

strickvl
Copy link
Contributor

@strickvl strickvl commented Jan 18, 2024

Some of our scheduled actions are currently running on forked repositories. They are failing (mainly due to missing passwords etc) but still we should confine these to just running from within ZenML. Added some other conditionals in places where it seemed to make sense that we'd want to prevent these from running outside as well.

Summary by CodeRabbit

  • Chores
    • Improved workflow conditions across various GitHub Actions to ensure they run exclusively for the primary repository (zenml-io/zenml).

@strickvl strickvl added bug Something isn't working internal To filter out internal PRs and issues labels Jan 18, 2024
Copy link
Contributor

coderabbitai bot commented Jan 18, 2024

Important

Auto Review Skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository.

To trigger a single review, invoke the @coderabbitai review command.

Walkthrough

The recent updates to the GitHub workflows introduce conditional execution based on repository checks. Jobs within various workflows now include a prerequisite that they will only run if the repository matches 'zenml-io/zenml'. This ensures that workflow actions such as analyzing code, posting data, nightly builds, labeling pull requests, publishing packages, and updating documents are specifically tailored for the ZenML repository, avoiding unintended executions in forks or other repositories.

Changes

Files Change Summary
.github/workflows/codeql.yml Trigger analyze job only for non-draft PRs in 'zenml-io/zenml'.
.github/workflows/.../mixpanel-test-data.yml, .../publish_api_docs.yml, .../replace_api_docs_version, .../trivy-zenserver.yml Run jobs only if the repository is 'zenml-io/zenml'.
.github/workflows/.../nightly_build.yml, .../release.yml Conditional checks on publish-python-package, wait-for-package-release, publish-docker-image, and publish-helm-chart jobs for 'zenml-io/zenml'.
.github/workflows/pr_labeler.yml, .github/workflows/spellcheck.yml Run jobs only for PRs from 'zenml-io/zenml'.
.github/workflows/.../templates-test.yml Conditional execution based on commit message and the repository being 'zenml-io/zenml'.
.github/workflows/trivy-zenml-core.yml No changes.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit-tests for this file.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit tests for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

@strickvl
Copy link
Contributor Author

@coderabbitai review

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Review Status

Actionable comments generated: 0

Configuration used: .coderabbit.yaml

Commits Files that changed from the base of the PR and between 0662597 and 08cc5b8.
Files selected for processing (11)
  • .github/workflows/codeql.yml (1 hunks)
  • .github/workflows/mixpanel-test-data.yml (1 hunks)
  • .github/workflows/nightly_build.yml (1 hunks)
  • .github/workflows/pr_labeler.yml (1 hunks)
  • .github/workflows/publish_api_docs.yml (1 hunks)
  • .github/workflows/release.yml (2 hunks)
  • .github/workflows/replace_api_docs_version (1 hunks)
  • .github/workflows/spellcheck.yml (1 hunks)
  • .github/workflows/templates-test.yml (1 hunks)
  • .github/workflows/trivy-zenml-core.yml (1 hunks)
  • .github/workflows/trivy-zenserver.yml (1 hunks)
Additional comments: 16
.github/workflows/pr_labeler.yml (1)
  • 10-10: The addition of the conditional check if: github.repository == 'zenml-io/zenml' is correct and aligns with the PR's objective to restrict actions to the main repository.
.github/workflows/trivy-zenml-core.yml (1)
  • 11-11: The addition of the conditional check if: github.repository == 'zenml-io/zenml' is correct and aligns with the PR's objective to restrict actions to the main repository.
.github/workflows/trivy-zenserver.yml (1)
  • 11-11: The addition of the conditional check if: github.repository == 'zenml-io/zenml' is correct and aligns with the PR's objective to restrict actions to the main repository.
.github/workflows/spellcheck.yml (1)
  • 18-18: The addition of the conditional check if: github.event.pull_request.draft == false && github.repository == 'zenml-io/zenml' is correct and aligns with the PR's objective to restrict actions to the main repository.
.github/workflows/mixpanel-test-data.yml (1)
  • 10-10: The addition of the conditional check if: github.repository == 'zenml-io/zenml' is correct and aligns with the PR's objective to restrict actions to the main repository.
.github/workflows/nightly_build.yml (4)
  • 16-16: The addition of the conditional check if: github.repository == 'zenml-io/zenml' for the setup-and-test job is correct and aligns with the PR's objective.
  • 21-21: The addition of the conditional check if: github.repository == 'zenml-io/zenml' for the publish-python-package job is correct and aligns with the PR's objective.
  • 23-23: The addition of the conditional check if: github.repository == 'zenml-io/zenml' for the wait-for-package-release job is correct and aligns with the PR's objective.
  • 31-31: The addition of the conditional check if: github.repository == 'zenml-io/zenml' for the publish-docker-image job is correct and aligns with the PR's objective.
.github/workflows/publish_api_docs.yml (1)
  • 9-9: The addition of the conditional check if: github.repository == 'zenml-io/zenml' for the publish job is correct and aligns with the PR's objective to restrict actions to the main repository.
.github/workflows/codeql.yml (1)
  • 12-12: The addition of the conditional check if: github.event.pull_request.draft == false && github.repository == 'zenml-io/zenml' for the analyze job is correct and aligns with the PR's objective to restrict actions to the main repository.
.github/workflows/replace_api_docs_version (1)
  • 11-11: The addition of the conditional check if: github.repository == 'zenml-io/zenml' for the update_docs job is correct and aligns with the PR's objective to restrict actions to the main repository.
.github/workflows/templates-test.yml (1)
  • 45-46: The addition of the conditional check if: ${{ ! startsWith(github.event.head_commit.message, 'GitBook:') }} && github.repository == 'zenml-io/zenml' for the all-template-tests job is correct and aligns with the PR's objective to restrict actions to the main repository.
.github/workflows/release.yml (3)
  • 65-65: The addition of the conditional check if: github.repository == 'zenml-io/zenml' for the publish-python-package job is correct and aligns with the PR's objective.
  • 82-82: The addition of the conditional check if: github.repository == 'zenml-io/zenml' for the publish-docker-image job is correct and aligns with the PR's objective.
  • 87-87: The addition of the conditional check if: github.repository == 'zenml-io/zenml' for the publish-helm-chart job is correct and aligns with the PR's objective.

Copy link
Contributor

Quickstart template updates in examples/quickstart have been pushed.

Copy link
Contributor

E2E template updates in examples/e2e have been pushed.

Copy link
Contributor

NLP template updates in examples/e2e_nlp have been pushed.

@strickvl strickvl merged commit ad11197 into develop Jan 20, 2024
4 checks passed
@strickvl strickvl deleted the bugfix/nightly-release-not-on-forks branch January 20, 2024 10:01
kabinja pushed a commit to kabinja/zenml that referenced this pull request Jan 29, 2024
…rked repositories (zenml-io#2317)

* add conditioal check for forks

* Auto-update of Starter template

* Auto-update of E2E template

* Auto-update of NLP template

---------

Co-authored-by: GitHub Actions <[email protected]>
adtygan pushed a commit to adtygan/zenml that referenced this pull request Mar 21, 2024
…rked repositories (zenml-io#2317)

* add conditioal check for forks

* Auto-update of Starter template

* Auto-update of E2E template

* Auto-update of NLP template

---------

Co-authored-by: GitHub Actions <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working internal To filter out internal PRs and issues
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants