v0.0.17 - `hub-sdk 0.0.17` Security improvements (#232)

🌟 Summary

The v0.0.17 release of the Ultralytics HUB SDK introduces several significant updates focused on improving workflow efficiency, modularity, and security, alongside minor adjustments for branding consistency and versioning. 🚀✨

---

📊 Key Changes

• Enhanced CI/CD Workflow (PR #231 & #229):

  • Introduced modular stages (check, build, publish, notify) for better process clarity. 🛠️
  • Improved version-checking logic for smarter package building and publishing. 🔍
  • Added Slack notifications for release status updates. 📣
  • Implemented granular permissions for better security. 🔒

• Security Improvements & Workflow Adjustments (PR #230 & #227):

  • Changed GitHub CI workflow trigger to pull_request for better safety against untrusted forked code. 🛡️
  • Removed the CodeQL workflow file, simplifying maintenance. 🗑️

• Branding and Documentation Updates (PR #228):

  • Updated assets (favicon and logo) to use externally hosted versions, ensuring lightweight repo size and unified branding. ✨

• Version Bump to 0.0.17 (PR #232):

  • Updated the SDK version, incorporating all the latest fixes and improvements. 🔧

---

🎯 Purpose & Impact

• 🚀 Improved Developer Experience:

  • Modularized workflows with clearer steps reduce maintenance complexity and error rates, making debugging and scaling easier.
  • Notifications keep teams up-to-date on release progress.

• 🔒 Enhanced Security:

  • Adjustments to GitHub workflows and permissions prioritize safety and align with best practices, minimizing risks in CI/CD pipelines.

• ✨ Streamlined Asset Management:

  • External hosting of logo and favicon reduces repository clutter and ensures consistent branding across all documentation.

• 📦 Latest Features with 0.0.17:

  • Version bump ensures users access the newest updates, bug fixes, and improvements for a more reliable SDK experience.

This release underscores Ultralytics’ commitment to security, quality, and developer-focused enhancements, paving the way for a smoother and safer development lifecycle. 🌟

What's Changed

• Ultralytics Refactor https://ultralytics.com/actions by @pderrenger in #226
• Delete .github/workflows/codeql.yaml by @glenn-jocher in #227
• Favicon updates by @glenn-jocher in #228
• Update publish.yml by @glenn-jocher in #229
• Update ci.yml by @glenn-jocher in #230
• Split PyPI publish jobs for improved security by @glenn-jocher in #231
• hub-sdk 0.0.17 Security improvements by @glenn-jocher in #232

Full Changelog: v0.0.16...v0.0.17

v0.0.16 - Fix publish.yml Slack step (#225)

🌟 Summary

The v0.0.16 release focuses on enhancing the GitHub Actions workflow notifications and improving the overall code efficiency and reliability.

📊 Key Changes

• Enhanced Notifications: The Slack notification format was updated to include the pull request title in alerts, providing more context.
• Slack API Update: Updated slackapi/slack-github-action to version 2.0.0 for better error handling and notification capabilities.
• Refactored Workflows: Improved the CI/CD workflow by optimizing retry logic with a new custom action.
• Code Optimization: Various code improvements for better performance and readability.

🎯 Purpose & Impact

• Improved Clarity in Alerts: Including the PR title in alerts makes it easier for team members to quickly identify issues and review relevant pull requests. 🛠️
• Better Communication: Enhanced notifications improve team awareness of workflow events and outcomes. 📣
• Enhanced Workflow Efficiency: Code optimizations and using the updated Slack API provide smoother, more reliable operations, reducing potential errors and downtime. 🔄
• Version Update: Incrementing the version ensures users benefit from the latest fixes and improvements, maintaining a stable and up-to-date SDK experience. 🚀

What's Changed

• Fix PyPI downloads links by @pderrenger in #220
• Use new Ultralytics Retry action by @pderrenger in #221
• Use new Ultralytics Retry action by @pderrenger in #222
• Bump slackapi/slack-github-action from 1.27.0 to 2.0.0 in /.github/workflows by @dependabot[bot] in #223
• Update to Slack API v2 by @glenn-jocher in #224
• Fix publish.yml Slack step by @glenn-jocher in #225

Full Changelog: v0.0.15...v0.0.16

v0.0.15 - Update environment in publish.yml (#219)

🌟 Summary

The 'v0.0.15' release updates the publishing workflow and marks a new version for the SDK, focusing on improving deployment processes.

📊 Key Changes

• Updated Publishing Workflow: The GitHub Actions publish.yml workflow now includes a new environment setting for deployment tracking.
• Version Bump: Updated the SDK version from 0.0.14 to 0.0.15, reflecting the recent improvements and updates.

🎯 Purpose & Impact

• Improved Deployment Tracking: By incorporating the environment setting into the workflow, this update enables enhanced tracking of deployments using GitHub's native features, facilitating smoother and more efficient release management. 🚀
• Signal of Incremental Improvements: The version bump indicates that users can expect improvements or minor fixes, ensuring they are using the most up-to-date and stable version of the SDK. 📈

What's Changed

• Update environment in publish.yml by @glenn-jocher in #219

Full Changelog: v0.0.14...v0.0.15

v0.0.14 - Update publish.yml (#218)

🌟 Summary

The v0.0.14 release of the Ultralytics Hub SDK introduces a series of enhancements focused on workflow automation and future-forward compatibility, alongside improvements in communication and process efficiency.

📊 Key Changes

• 🔄 Updated GitHub Actions workflows, especially for publishing, with enhanced Slack notifications utilizing current_tag over version.
• 🆙 Increment of SDK version to 0.0.14.
• 🔧 Enhanced security by refining token and permission handling in workflows.
• 🛠️ Streamlined workflow steps for building and publishing packages, utilizing specialized actions and utilities.
• 📢 Improved message clarity in README and Slack notifications.
• 🚀 Added compatibility with Python 3.13 and updated the required version for setuptools.

🎯 Purpose & Impact

• 📦 Accurate Communication: The use of current_tag in Slack messages ensures precise version updates are communicated effectively, improving team collaboration and awareness.
• 🔐 Security and Reliability: By refining permission settings and centralizing version checks, the updates enhance security and simplify the maintenance of workflows, reducing the likelihood of errors.
• 🌟 Streamlined Processes: The separation and centralization of critical tasks like version checking and package building result in more manageable, efficient, and error-free automated workflows.
• 🚀 Future-proofing: Adding Python 3.13 support ensures that the SDK remains compatible with upcoming technology trends, providing users with continued support and stability.
• 📚 Clearer Documentation: Updates to README and notifications support better user understanding and engagement, promoting the exploration of the platform's latest features.

What's Changed

• Update publish.yaml by @glenn-jocher in #209
• Update publish.yaml by @glenn-jocher in #210
• Fix publish action by @glenn-jocher in #211
• Use official PyPI action by @glenn-jocher in #212
• Update README.md by @glenn-jocher in #213
• Ultralytics Code Refactor https://ultralytics.com/actions by @UltralyticsAssistant in #214
• Update publish.yml by @glenn-jocher in #215
• Update publish.yml by @glenn-jocher in #216
• Python 3.13 update by @glenn-jocher in #217
• Update publish.yml by @glenn-jocher in #218

Full Changelog: v0.0.13...v0.0.14

v0.0.13 - Ultralytics Code Refactor https://ultralytics.com/actions (#208)

🌟 Summary

The v0.0.13 release focuses on enhancing code performance and readability through strategic refactoring, alongside improvements in the publication workflow and other minor adjustments.

📊 Key Changes

• 🚀 Code Refactor:
  • Optimized functions for speedier execution.
  • Simplified complex code logic enhancing clarity and maintenance.
  • Removed unnecessary code to improve efficiency.
  • Structured code for better organization and readability.
• 🔄 Update to GitHub Action: Bumped the contributor-assistant/github-action version to 2.6.1, ensuring improved functionality.
• 🛠️ Publishing Workflow:
  • Simplified the PyPI upload process by removing explicit credential usage.
  • Used Twine's default authentication behavior for greater security.
• 📚 Documentation and Website Links:
  • Updated links and badges for better user navigation and information access.

🎯 Purpose & Impact

• Enhanced Performance: The refactoring leads to faster code execution, streamlining operations and reducing execution time. 🚀
• Improved Code Maintainability: Simpler logic and better structure make the codebase easier to understand and modify, providing long-term maintenance benefits. 🧩
• Security and Process Efficiency: By adjusting the publishing workflow to rely less on explicit credentials, security is enhanced, and the process is more efficient. ✅
• User Accessibility: Updated documentation and links offer better accessibility, making it easier for users to find resources and support. 🌐

Overall, these updates bring a more robust, secure, and user-friendly experience to the Ultralytics community.

What's Changed

• Bump contributor-assistant/github-action from 2.5.2 to 2.6.1 in /.github/workflows by @dependabot[bot] in #206
• Update publish.yaml for trusted publisher by @glenn-jocher in #207
• Ultralytics Code Refactor https://ultralytics.com/actions by @UltralyticsAssistant in #208

Full Changelog: v0.0.12...v0.0.13

v0.0.12 - Update hub_client.py for single API call (#205)

🌟 Summary

Ultralytics SDK update focusing on version increment and simplifying code for better model management.

📊 Key Changes

• Updated SDK version from 0.0.11 to 0.0.12.
• Removed the authentication requirement from the model function in hub_client.py.

🎯 Purpose & Impact

• Version Update: This ensures that users have the latest features and improvements, indicating ongoing maintenance and enhancements of the SDK. 🆙
• Code Simplification: By removing the authentication decorator from the model function, the code becomes cleaner and easier to maintain. It simplifies the process for users to interact with models, possibly speeding up workflows and reducing errors associated with authentication. 🚀

What's Changed

• Bump contributor-assistant/github-action from 2.5.1 to 2.5.2 in /.github/workflows by @dependabot[bot] in #204
• Update hub_client.py for single API call by @glenn-jocher in #205

Full Changelog: v0.0.11...v0.0.12

v0.0.11 - `hub-sdk 0.0.11` (#203)

🌟 Summary

The release of version 0.0.11 for the Ultralytics HUB-SDK introduces several updates, primarily refining workflows, enhancing documentation, and optimizing the software development process.

📊 Key Changes

• Version Increment: The SDK is now updated from version 0.0.10 to 0.0.11, signifying minor improvements.
• Workflow Enhancements: Updated Slack integration from version 1.26.0 to 1.27.0, allowing for new optional features in message formatting.
• Documentation Plugin Update: Enhanced the mkdocs-ultralytics-plugin from version 0.1.2 to 0.1.8 to improve meta descriptions, images, and author detailing.
• Code Refactor: Streamlined code for improved performance, readability, and maintenance.
• .gitignore Expansion: Broadened file patterns to ignore, helping manage development artifacts effectively.
• Project Metadata Improvement: Added URL links for enhanced project navigation and clarity.
• Deprecated Workflows and Badges: Removed the "Greetings" GitHub Action and the Codecov badge for a cleaner setup.

🎯 Purpose & Impact

• Improved Development Experience: By updating the SDK version and refining the .gitignore, the development pipeline becomes more efficient and easier to manage. 🛠️
• Enhanced Documentation: The documentation updates ensure users can easily navigate and understand project changes, boosting usability and transparency. 📚
• Refined Workflow Automation: Updates in Slack notifications and publishing processes streamline team communication and deployment, reducing errors and improving release reliability. 🚀
• User Engagement: Removing unnecessary actions and badges focuses users on the essential aspects of the repository, aiding clearer communication and experience. 😊

Overall, the version 0.0.11 release sharpens functionality and enhances user interaction with both the project’s processes and its documentation.

What's Changed

• PyUpgrade 3.8 updates by @glenn-jocher in #191
• Bump slackapi/slack-github-action from 1.26.0 to 1.27.0 in /.github/workflows by @dependabot[bot] in #192
• Update mkdocs-ultralytics-plugin>=0.1.8 by @glenn-jocher in #193
• Ultralytics Code Refactor https://ultralytics.com/actions by @UltralyticsAssistant in #196
• Update .gitignore by @glenn-jocher in #197
• Delete .github/workflows/greetings.yml by @UltralyticsAssistant in #199
• Update publish.yaml by @glenn-jocher in #200
• Update pyproject.toml project URLs by @glenn-jocher in #201
• Remove codecov from README by @glenn-jocher in #202
• hub-sdk 0.0.11 by @glenn-jocher in #203

Full Changelog: v0.0.10...v0.0.11

v0.0.10 - Update to v0.0.10 (#190)

🌟 Summary

The release of version 0.0.10 focuses on enhancing code readability, improving performance, and refining the development workflow. 🔄

📊 Key Changes

• 🚀 Code refactoring for optimized performance and better readability.
• 🌐 Updated GitHub Actions workflows for cleaner and more efficient automation.
• 📈 Version bump of 'hub-sdk' from 0.0.9 to 0.0.10.
• 💬 Added a Reddit badge to the README for community engagement.
• 🔧 Minor code cleanup and formatting in test files.
• 🛠️ Transitioned from OpenAI API to a direct scripting method for generating release summaries.

🎯 Purpose & Impact

• Performance Boost: Refactoring improves the speed and efficiency of various functions, benefiting applications by reducing computational overhead. 🚀
• Enhanced Code Quality: Simplified logic and cleaned-up code make the codebase easier to maintain and understand, which is especially helpful for developers contributing to the project. 🗂️
• Streamlined Workflow: With updated GitHub Action workflows, there is a reduction in dependencies and enhanced reliability, aiding smoother CI/CD processes. 🛠️
• Improved Communication: Adding a Reddit badge helps users connect with the community, providing a platform for discussion and support. 🗨️
• User Guidance: Version updates ensure that users are interacting with the latest and most efficient version of the software, paving the way for seamless experiences and access to the latest features. 📈

These updates collectively aim to streamline operations, improve user experience, and facilitate more robust software development processes. 🌟

What's Changed

• Add https://www.reddit.com/r/Ultralytics/ badge by @glenn-jocher in #187
• Ruff Docs reformat by @glenn-jocher in #186
• Update publish.yaml by @glenn-jocher in #189
• Update publish.yml to GPT4o-08-06 by @glenn-jocher in #180
• Fix repo name in publish.yaml action by @glenn-jocher in #179
• Update to v0.0.10 by @glenn-jocher in #190
• Bump contributor-assistant/github-action from 2.4.0 to 2.5.1 in /.github/workflows by @dependabot[bot] in #181
• Update publish.yaml to use gh by @glenn-jocher in #182
• Update publish.yaml by @glenn-jocher in #188

Full Changelog: v0.0.9...v0.0.10

v0.0.9 - Update publish.yaml (#178)

🌟 Summary

The v0.0.9 update for the Ultralytics HUB-SDK introduces comprehensive enhancements across workflows, documentation, and core functionalities, ensuring improved automation, richer feature integration, and heightened user experience.

📊 Key Changes

• CI/CD Workflow Enhancements:
  • Environment Variables and Secrets Added: Configuration for Firebase and Ultralytics services.
  • New Workflow Jobs: Separate jobs for tests, documentation build, and Slack notifications on failures.
• CLA Workflow Updated:
  • Permissions Added and Action Version Bumped: Ensuring smoother contributions.
• Format Workflow Revamped:
  • Updated Triggers and Added Prettier: Enhanced code formatting for multiple file types.
• Link Check Workflow Improved:
  • User-Agent Header Added: More robust link validation.
• New Unified Publish Workflow:
  • Combined and Replaced Staging/Production Workflows: Streamlined PyPI publishing.
• Documentation:
  • Extended Descriptions and Keywords: Improved SEO and readability.
  • Multiple Ready-to-Use Guide Additions: Enriching user learning.
• Code Refactoring:
  • Improved Error Handling and Logging: More precise function and class documentation, with added logging for debuggable error messages.
  • Static Method Definitions: Clear and consistent usage in error handlers and model processing.
• Testing:
  • Extensive Test Suite Addition: Functional and unit tests for datasets, models, and project workflows.
  • Comprehensive Test Data Management: Firebase integrated for test data upload/download.

🎯 Purpose & Impact

• Enhanced Automation: Streamlines Continuous Integration and Continuous Deployment (CI/CD) with more robust and informative workflows.
  • Impact: Ensures smoother and automated releases, improving reliability and consistency.
• Contributor Experience: Easier and safer contributions via updated CLA checks and permissions.
  • Impact: Fosters a more inclusive and active developer community.
• Code Quality and Maintenance: Automatic formatting, link validations, and summarized pull requests with GPT4.
  • Impact: Reduces human error, enhances code readability, and improves overall project maintainability.
• User Documentation: Better outlined instructions and guides in the documentation.
  • Impact: Empowers users with clearer setup and troubleshooting instructions leading to enhanced user satisfaction.
• Error Handling Improvements: More refined error messages and logging mechanisms.
  • Impact: Faster issue diagnosis and resolution for developers, leading to more stable builds.

By implementing these updates, v0.0.9 significantly elevates the usability, maintainability, and overall developer experience of the Ultralytics HUB-SDK. 🚀

What's Changed

• Update publish action by @sergiuwaxmann in #117
• Integrate Continuous Testing Workflow by @yogendrasinghx in #116
• Merge Continuous Testing into Continuous Integration Workflow by @yogendrasinghx in #120
• Report failures to Slack by @glenn-jocher in #121
• chore(deps): bump slackapi/slack-github-action from 1.25.0 to 1.26.0 in /.github/workflows by @dependabot in #122
• Update to MkDocs 1.6.0 by @glenn-jocher in #125
• Add missing docstrings by @glenn-jocher in #126
• Update pyproject.toml setuptools>=57.0.0 by @glenn-jocher in #127
• Unpin Tests requirements by @dependabot in #128
• Fix parameterization issues by aligning pagination parameters between… by @hassaanfarooq01 in #130
• Handle Missing Project or Dataset by Displaying Error Message Instead… by @hassaanfarooq01 in #123
• pagination issues with hub-sdk by @hassaanfarooq01 in #124
• Replace %s with f-string in hub-sdk for Better Readability and Perfor… by @hassaanfarooq01 in #131
• Handle Missing Users and Teams by Displaying Error Message Instead of… by @hassaanfarooq01 in #132
• Simplify Python by @glenn-jocher in #133
• Fix Firebase CRED decoding by @sergiuwaxmann in #135
• Switch CI to pull_request_target by @glenn-jocher in #136
• Corrected Docs code examples by @RizwanMunawar in #134
• Minor docs update by @glenn-jocher in #138
• Bump contributor-assistant/github-action from 2.3.2 to 2.4.0 in /.github/workflows by @dependabot in #139
• Reformat Markdown code blocks by @glenn-jocher in #140
• Update Ultralytics YouTube URL by @glenn-jocher in #141
• Update docs by @glenn-jocher in #142
• Code Refactor for Speed and Readability by @pderrenger in #143
• Fix typo in teams.py by @glenn-jocher in #145
• Docs Prettier refactor by @glenn-jocher in #146
• Update pyproject.toml to "mkdocs-ultralytics-plugin>=0.0.48" by @glenn-jocher in #147
• Update quickstart.md by @glenn-jocher in #149
• Update cla.yml by @glenn-jocher in #151
• Ultralytics Code Refactor https://ultralytics.com/actions by @glenn-jocher in #153
• Fix HUB link https://ultralytics.com/hub by @glenn-jocher in #154
• Ultralytics Code Refactor https://ultralytics.com/actions by @glenn-jocher in #156
• Fix Ultralytics HUB capitalization by @glenn-jocher in #159
• Bump mkdocs-ultralytics-plugin>=0.0.49 by @glenn-jocher in #160
• Ultralytics Asset URL Update by @glenn-jocher in #162
• Add Discourse at https://community.ultralytics.com by @glenn-jocher in #161
• Ultralytics Code Refactor https://ultralytics.com/actions by @glenn-jocher in #168
• Fix branding by @glenn-jocher in #170
• Update Docs reference by @glenn-jocher in #171
• Update links.yml by @glenn-jocher in #172
• Update format.yml for Issue autolabel by @glenn-jocher in #173
• Update mkdocs-ultralytics-plugin>=0.1.0 by @glenn-jocher in #174
• Update mkdocs-ultralytics-plugin>=0.1.2 by @glenn-jocher in #175
• Ultralytics Actions JSON, CSS and autolabel support by @UltralyticsAssistant in #176
• YOLO Vision 2024 updates https://ultralytics.com/events/yolovision by @glenn-jocher in #177
• Update publish.yaml by @glenn-jocher in #178

New Contributors

• @RizwanMunawar made their first contribution in #134
• @UltralyticsAssistant made their first contribution in #176

Full Changelog: v0.0.8...v0.0.9