Ultralytics-actions

🌟 Summary
This release (v0.0.60) focuses on improving the handling of long search queries and broken links, making the system more robust and user-friendly.

📊 Key Changes
- 🚨 **Query Truncation**: Brave Search queries exceeding 400 characters are now automatically truncated, with a warning message displayed.
- 🔗 **Enhanced Link Replacement**: Improved logic for replacing broken links, even when the Brave API key is unavailable.
- ✂️ **Title and URL Length Limits**: Titles and URLs are now capped at 200 characters during alternative URL searches.
- 🔄 **Version Update**: Incremented version from 0.0.59 to 0.0.60.

🎯 Purpose & Impact
- 🛡️ **Increased Stability**: Prevents errors caused by overly long search queries, ensuring smoother operation.
- 🔧 **Better Link Handling**: Offers robust fallback mechanisms for broken links, improving reliability even in limited configurations.
- 🌟 **Improved User Experience**: Clearer warnings and smarter query handling make the system more intuitive and efficient.
- 📈 **Enhanced Usability**: These updates collectively enhance the overall functionality and reliability of the platform.

This update ensures a more seamless and error-free experience for users, especially when dealing with complex queries or broken links. 🚀

What's Changed
* Brave query truncation at 400 characters by glenn-jocher in https://github.com/ultralytics/actions/pull/403


**Full Changelog**: https://github.com/ultralytics/actions/compare/v0.0.59...v0.0.60

🌟 Summary
The v0.0.59 release introduces integration with the Brave Search API to enhance link validation and replacement capabilities within Ultralytics GitHub Actions.

📊 Key Changes
- Added Brave Search API support with a new `brave_api_key` input.
- Implemented a `brave_search` function to find alternative URLs for broken links.
- Enhanced the `check_links_in_string` function to optionally replace broken links with alternatives from Brave Search.
- Updated workflows and environment variables to include Brave API key support.
- Version incremented from `0.0.58` to `0.0.59`.

🎯 Purpose & Impact
- **Purpose**: To improve the reliability of link validation by automating the replacement of broken links with functional alternatives using Brave Search.
- **Impact**:
- Saves time by reducing manual effort in fixing broken links.
- Enhances workflow efficiency by ensuring smoother operations with fewer interruptions caused by invalid links.
- Provides a more robust and automated solution for maintaining link integrity.

🚀 This update is a step forward in streamlining link management and ensuring a seamless user experience for developers and contributors!

What's Changed
* Add Brave search API by glenn-jocher in https://github.com/ultralytics/actions/pull/400


**Full Changelog**: https://github.com/ultralytics/actions/compare/v0.0.58...v0.0.59

🌟 Summary
The v0.0.58 release introduces improved URL handling, enhanced disk cleanup, and better markdown processing, alongside general code optimizations. These updates aim to streamline workflows, improve reliability, and enhance user experience. 🚀

---

📊 Key Changes
- **URL Handling Enhancements**: Updated URL validation logic to exclude specific patterns (`(` and `api`) to prevent errors in pattern matching.
- **Disk Cleanup Improvements**: Added functionality to remove swap space, freeing up an additional ~4GB of disk space.
- **Markdown Code Block Processing**: Enhanced the script to process both Python and Bash code blocks in markdown files.
- **Code Refactoring**: Optimized functions, simplified logic, and removed redundant code for better performance and maintainability.
- **Version Update**: Incremented version to 0.0.58 to reflect these improvements.

---

🎯 Purpose & Impact
- 🛠️ **Improved Reliability**: The refined URL handling reduces false positives, ensuring smoother workflows when processing links or API endpoints.
- 💾 **Optimized Storage**: By removing swap files, developers gain more available disk space, improving performance during workflows.
- 📚 **Better Documentation Maintenance**: Automating updates for Python and Bash code blocks ensures consistent and accurate documentation.
- 🚀 **Enhanced Efficiency**: Refactored code improves execution speed and simplifies maintenance for developers.
- 🔄 **Streamlined Updates**: The version bump ensures clarity and transparency for users tracking changes.

These updates collectively enhance the robustness, efficiency, and usability of the Ultralytics ecosystem, benefiting both developers and end-users. 🌟

What's Changed
* Update update_markdown_code_blocks.py by glenn-jocher in https://github.com/ultralytics/actions/pull/396
* Update cleanup-disk action to remove swap space by glenn-jocher in https://github.com/ultralytics/actions/pull/397
* Ultralytics Refactor https://ultralytics.com/actions by pderrenger in https://github.com/ultralytics/actions/pull/398
* Update common_utils.py by glenn-jocher in https://github.com/ultralytics/actions/pull/399


**Full Changelog**: https://github.com/ultralytics/actions/compare/v0.0.57...v0.0.58

🌟 Summary
This release enhances the GitHub Action by adding support for formatting Bash code blocks in Markdown files, alongside Python code blocks. 🎉

📊 Key Changes
- Introduced detection and formatting for Bash code blocks (`bash`, `sh`, `shell`) in Markdown files.
- Integrated the `prettier-plugin-sh` tool for consistent Bash formatting.
- Updated the code processing logic to handle both Python and Bash code blocks.
- Added options to toggle between Python and Bash formatting during execution.
- Incremented the version from `0.0.56` to `0.0.57`.

🎯 Purpose & Impact
- **Purpose**: To improve documentation quality by ensuring both Python and Bash code blocks in Markdown files are consistently formatted.
- **Impact**: Users benefit from cleaner, more professional-looking documentation with enhanced readability. This update is particularly useful for projects that include Bash scripts in their documentation. 🚀

What's Changed
* Format bash code blocks by glenn-jocher in https://github.com/ultralytics/actions/pull/395


**Full Changelog**: https://github.com/ultralytics/actions/compare/v0.0.56...v0.0.57

🌟 Summary
This release focuses on improving communication and usability in GitHub issue comments by including PR titles and enhancing testing instructions.

📊 Key Changes
- Added PR titles to issue comments for better context and clarity.
- Enhanced testing instructions in comments, including version-specific installation commands and alternative methods.
- Updated the process for generating issue comments to include more personalized and detailed information.
- Incremented the version from `0.0.55` to `0.0.56`.

🎯 Purpose & Impact
- **Improved Clarity**: Adding PR titles makes comments more informative, helping users quickly understand the changes.
- **Enhanced Testing Guidance**: Clearer instructions empower users to test fixes more effectively, reducing confusion and improving feedback loops.
- **Streamlined Communication**: Personalized and detailed comments foster better collaboration and understanding between contributors and users.

🎉 This update enhances the overall user experience and communication flow, making it easier for everyone to stay informed and contribute effectively! 🚀

What's Changed
* Include new release version in PR merge comment by glenn-jocher in https://github.com/ultralytics/actions/pull/394


**Full Changelog**: https://github.com/ultralytics/actions/compare/v0.0.55...v0.0.56

🌟 Summary
The v0.0.55 release focuses on improving code clarity, functionality, and user experience in the Ultralytics Actions repository. Key updates include refined error handling, enhanced debugging options, and better formatting utilities.

📊 Key Changes
- **New Utility Function**: Added `remove_outer_codeblocks` to clean up code block formatting in markdown files.
- **Improved Error Handling**: Simplified return values in the `label_fixed_issues` function for better reliability.
- **Debugging Enhancements**: Introduced a `verbose` option in `process_markdown_file` to aid in debugging markdown processing.
- **Documentation Improvements**: Updated docstrings and comments for better clarity and consistency.
- **OpenAI Response Handling**: Adjusted response processing to remove unnecessary content.

🎯 Purpose & Impact
- **Enhanced Code Quality**: Improved readability and maintainability of the codebase, making it easier for developers to contribute and debug.
- **Streamlined Markdown Processing**: The new utility function ensures cleaner and more consistent markdown formatting, benefiting documentation workflows.
- **Better Debugging Experience**: The `verbose` option provides more detailed insights during markdown file processing, helping users identify issues faster.
- **Improved User Experience**: Cleaner error handling and response processing lead to smoother interactions with the system.

🚀 This update ensures a more polished and developer-friendly experience for users working with Ultralytics Actions!

What's Changed
* Remove outer codeblocks by glenn-jocher in https://github.com/ultralytics/actions/pull/393


**Full Changelog**: https://github.com/ultralytics/actions/compare/v0.0.54...v0.0.55