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

Misc CI bugfixes #2260

Merged
merged 8 commits into from
Jan 15, 2024
Merged

Misc CI bugfixes #2260

merged 8 commits into from
Jan 15, 2024

Conversation

strickvl
Copy link
Contributor

@strickvl strickvl commented Jan 10, 2024

This PR addresses 4 separate small issues:

  • addresses the failure of nightly builds (as seen here. I was too zealous in adding the -nightly suffix. This should fix it.
  • Address the failing API docs publication script (last seen failing here).
  • Exclude the new requirements file from the typos check.
  • stops dependabot from trying to update dependencies outside the .github workflows folder. (Also make the check happen a couple of hours earlier).

Summary by CodeRabbit

  • Chores

    • Updated the Dependabot configuration for better GitHub Actions maintenance.
    • Refined the automatic documentation publishing workflow for clarity and accuracy.
  • Documentation

    • Improved the API documentation generation process.
    • Excluded specific files from typo checks to enhance documentation quality.

Copy link
Contributor

coderabbitai bot commented Jan 10, 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 project repository has been updated to refine automation processes. Dependabot's configuration now targets a different directory and schedule for GitHub Actions updates, while the workflow for documentation has been renamed and adjusted to trigger on different branches. Additionally, the documentation generation script and typo exclusions have been updated to improve the build process and ignore specific files, enhancing the overall maintenance and deployment of project resources.

Changes

File Path Change Summary
.github/dependabot.yml Updated directory path for GitHub Actions, changed scheduled time to 07:00, set timezone to Europe/Amsterdam.
.github/workflows/.../publish_api_docs.yml Renamed workflow to "Publish SDK Docs," updated trigger branch, removed job description, renamed job to "Build 🔨 and publish 📰 the api docs 📁 to gh-pages."
.typos.toml Added "docs/requirements-docs-frozen.txt" to extend-exclude list.
scripts/generate-docs.sh Modified installation process and API docs build, including a temporary fix for dependencies and updated comments.

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.

@github-actions github-actions bot added internal To filter out internal PRs and issues bug Something isn't working labels Jan 10, 2024
@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 5e47b81 and 5bdb57a.
Files ignored due to filter (1)
  • release-cloudbuild-nightly.yaml
Files selected for processing (4)
  • .github/dependabot.yml (1 hunks)
  • .github/workflows/publish_api_docs.yml (1 hunks)
  • .typos.toml (1 hunks)
  • scripts/generate-docs.sh (2 hunks)
Files skipped from review due to trivial changes (4)
  • .github/dependabot.yml
  • .github/workflows/publish_api_docs.yml
  • .typos.toml
  • scripts/generate-docs.sh

Copy link
Contributor

@avishniakov avishniakov left a comment

Choose a reason for hiding this comment

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

🦭

@strickvl strickvl merged commit 4f5d1a5 into develop Jan 15, 2024
33 checks passed
@strickvl strickvl deleted the bugfix/ci-fixes-minor branch January 15, 2024 09:07
kabinja pushed a commit to kabinja/zenml that referenced this pull request Jan 29, 2024
* ignore non-github actions dependencies

* exclude requirements file

* Fix nightly Docker builds

* fix for SDK docs publication

* run the api docs build script on CI (minus pushing)

* restore CI to normal services
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