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

Create ci.yml with Install and Docs steps #92

Closed
wants to merge 19 commits into from
Closed

Create ci.yml with Install and Docs steps #92

wants to merge 19 commits into from

Conversation

glenn-jocher
Copy link
Member

@glenn-jocher glenn-jocher commented Jan 24, 2024

@kalenmike @hassaanfarooq01 this preliminary CI action merely tests package installation and Docs publishing.

This action should fail if any docstring issues are present.

🛠️ PR Summary

Made with ❤️ by Ultralytics Actions

🌟 Summary

Implementing Continuous Integration (CI) workflow for Ultralytics HUB-SDK 🚀.

📊 Key Changes

  • Introduced ci.yml for GitHub Actions.
  • CI triggers on pushes and pull requests to main and develop branches, and also runs daily at 00:00 UTC.
  • CI includes steps to set up Python, install dependencies, and build documentation.
  • Includes a check for "Griffe warnings" that could prevent doc building and fails the job if any are found.

🎯 Purpose & Impact

  • Enhanced Quality Assurance: Automatically tests each update, ensuring robust code and documentation quality.
  • Efficient Project Maintenance: Helps maintainers quickly identify and resolve integration and documentation issues.
  • User Trust and Stability: Users can expect a more reliable and stable HUB-SDK, with fewer bugs slipping into production. 🛠️✨

@glenn-jocher
Copy link
Member Author

@kalenmike @hassaanfarooq01 ok guys I've got a super cool CI start here that will help you debug your docs.

There's no code tests yet (though you guys really need to add these), there's only an Install step and a Docs build step. The docs build step fails if any warnings are encountered:

So @hassaanfarooq01 your work is really simple here: go through these warnings and resolve them one by one until the CI is showing a green check mark, then we can merge this PR, and then I can proceed to publish the HUB-SDK reference section over in the ultralytics repo, which is being held up by this.

Screenshot 2024-01-24 at 14 41 27 Screenshot 2024-01-24 at 14 42 06

@kalenmike
Copy link
Member

@glenn-jocher Looks like this PR is failing due to setup issues.

@kalenmike kalenmike closed this Jan 26, 2024
@glenn-jocher glenn-jocher deleted the ci branch April 16, 2024 21:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants