v0.1.15 - Fix publish.yml hardcoded false values (#118)

🌟 Summary

The v0.1.15 release focuses on enhancing the CI/CD workflows for publishing and notifications, improving efficiency and security while refining the codebase for better performance and maintainability. 🚀✨

---

📊 Key Changes

Current PR #118: Fix publish.yml hardcoded false values

• Conditional Publishing: Publishing now happens only when a version increment is detected. ✅
• Always-Run Notifications: Notifications are set to run regardless but only provide updates when version changes occur. 🔂

Related Workflow Improvements:

• Job Splitting: Improved modularity by dividing the workflow into check, build, publish, and notify steps in PR #117.
• Version Management: Enhanced automation for determining PyPI version increments and managing release tags. 🏷️
• Slack Integration: Notifications now include job-specific context for success or failure. 📩

Codebase Enhancements:

• Refactors for Efficiency (PR #115): Functions optimized for speed, redundant code removed, and the logic simplified for easier maintenance. 🔄
• Dependency Management Upgrades (PR #116): Faster, more reliable dependencies with better caching mechanisms and modernized tools. ⚡

---

🎯 Purpose & Impact

• Streamlined Workflows: The CI/CD pipeline now runs more efficiently, saving time and resources for developers by targeting essential execution paths. ⏳💡
• Cleaner Codebase: Refactors improve code readability, maintainability, and overall system performance, benefiting contributors. 🛠️✨
• More Secure & Efficient Releases: By modularizing and enhancing dependency handling, releases are faster, safer, and less error-prone. 🔐🚀
• Improved Notifications: Clear and actionable notifications ensure teams are promptly informed about publishing results and updates. 🌍📢

This update makes the development process smoother, helping contributors and users with a faster, more reliable, and well-organized experience. 🌟

What's Changed

• Ultralytics Refactor https://ultralytics.com/actions by @pderrenger in #115
• Update publish.yml by @glenn-jocher in #116
• Split publish.yml jobs for improved security by @glenn-jocher in #117
• Fix publish.yml hardcoded false values by @glenn-jocher in #118

Full Changelog: v0.1.14...v0.1.15

v0.1.14 - Update publish.yml (#113)

🌟 Summary

The release of version v0.1.14 focuses on improving notification setups and enhancing documentation features by updating workflows and code structure.

📊 Key Changes

• Updated the Slack notification method to use incoming-webhook for a cleaner and more reliable integration.
• Removed unnecessary environment variable settings related to Slack notifications.
• Bumped the version of the MkDocs plugin to 0.1.14, indicating incremental improvements.
• Upgraded the Slack GitHub Action from version 1.27.0 to 2.0.0, introducing new features and formats such as YAML.
• Performed minor cleanup on the README by removing a redundant HTML tag.
• Refactored code for better performance, readability, and maintainability.

🎯 Purpose & Impact

• Streamlined Notifications: By simplifying the Slack notification setup, users benefit from a more dependable notification system, making it easier to track updates and activities. 📬
• Documentation Enhancements: The bump in the MkDocs plugin version ensures users have access to the latest functionalities and stability for enriched documentation experiences.
• Improved Code Quality: Refactoring efforts improve the overall performance and maintainability, making the project easier to work with for developers. 👨‍💻
• Updated Action with New Capabilities: The Slack action update introduces new features and enhances error handling, allowing for more flexibility and customization in workflow notifications. 🔧

These updates highlight the commitment to maintaining efficient workflows and clear, organized code while ensuring that users and developers have a reliable and feature-rich toolset.

What's Changed

• Fix PyPI downloads links by @pderrenger in #111
• Bump slackapi/slack-github-action from 1.27.0 to 2.0.0 in /.github/workflows by @dependabot[bot] in #112
• Update README.md by @glenn-jocher in #114
• Update publish.yml by @glenn-jocher in #113

Full Changelog: v0.1.13...v0.1.14

v0.1.13 - Update environment in publish.yml (#110)

🌟 Summary

The v0.1.13 release focuses on updates to the GitHub Actions workflow and supports the latest Python version.

📊 Key Changes

• 📄 Updated the workflow configuration for publishing to PyPI, enhancing the deployment process.
• 🔄 Increased plugin version from 0.1.12 to 0.1.13, indicating possible improvements or bug fixes.
• 🛠 Introduced deployment environment details (name and URL) for PyPI in the GitHub workflow.
• 🐍 Added support for Python 3.13 in the project configuration.
• 📝 Improved Slack message formatting for better readability in GitHub Actions.

🎯 Purpose & Impact

• 🚀 Smoother Deployments: The workflow improvements ensure more efficient releases to PyPI, facilitating easier maintenance and enhanced user access to up-to-date features.
• 🐍 Future-Proofing: By supporting Python 3.13, the project stays aligned with the latest Python developments, assuring users of continued compatibility and future support.
• 📈 Improved Infrastructure: The version bump typically signals behind-the-scenes enhancements or fixes, contributing to a more robust plugin experience.
• 🎨 Enhanced Communication: The formatted Slack messages assist in clearer notifications, although they bear no functional changes to the plugin itself.

What's Changed

• Python 3.13 update by @glenn-jocher in #108
• Update publish.yml by @glenn-jocher in #109
• Update environment in publish.yml by @glenn-jocher in #110

Full Changelog: v0.1.12...v0.1.13

v0.1.12 - Lazy load avatar images (#107)

🌟 Summary

The v0.1.12 release introduces lazy loading for avatar images, significantly enhancing performance and user experience on pages with multiple authors.

📊 Key Changes

• Lazy Loading for Avatars: Added the loading="lazy" attribute to avatar images in the on_post_page function of main.py.
• Styling Enhancements: Introduced background color and fade-in transitions for images to improve visual appearance during loading.

🎯 Purpose & Impact

• Performance Enhancement: By enabling lazy loading, the initial page load time is reduced, as images are only loaded when they appear in the user's viewport. This makes websites faster and more efficient. 🚀
• Improved User Experience: Users, especially those on slower connections or devices, will experience quicker and smoother navigation through pages with numerous author avatars. 🌐
• Visual Feedback: The fade-in effect enhances the aesthetic appeal, giving users a seamless and pleasant browsing experience as images load smoothly. 🎨

What's Changed

• Lazy load avatar images by @pderrenger in #107

Full Changelog: v0.1.11...v0.1.12

v0.1.11 - Update publish.yml (#106)

🌟 Summary

The release of v0.1.11 focuses on improving the publishing workflow by reducing complexity and enhancing process efficiency with new tools and strategies. 🚀

📊 Key Changes

• Version Checking Overhaul: Removed custom Python logic for version retrieval and publish decisions, integrating the check_pypi_version utility function from actions.utils.
• Dependency and Command Updates: Replaced requests with ultralytics-actions in the workflow, enabling simplified commands and functions.
• Workflow Token Updates: Modified how tokens are accessed to ensure a more secure and streamlined configuration.
• Documentation and Build Updates: Upgraded requirements for the build system to setuptools>=70.0.0, and updated the version to 0.1.11.

🎯 Purpose & Impact

• Efficiency: By using a utility function for version checks, the workflow becomes more efficient, reducing manual script maintenance and potential errors. 🏎️
• Maintainability: Improved maintainability with simplified and centralized logic, making future updates and troubleshooting easier for developers. 🔧
• Security and Consistency: Updated token handling increases security, while consistent token usage across workflows standardizes processes. 🔒
• Smoother Releases: Streamlined command sets and the introduction of ultralytics-actions reduce complexity in release management, facilitating quicker and more reliable deployments. 📦

These updates position the project for more agile development and deployment, enhancing overall user and developer experiences. 🏗️

What's Changed

• Update publish.yml by @glenn-jocher in #105
• Update publish.yml by @glenn-jocher in #106

Full Changelog: v0.1.10...v0.1.11

v0.1.10 - Update publish.yml to trusted publisher (#103)

🌟 Summary

The v0.1.10 release focuses on optimizing the plugin's publishing process to PyPI through enhanced GitHub Actions workflow, alongside minor updates to project metadata.

📊 Key Changes

• ✅ Integrated permissions for id-token in the GitHub workflow for PyPI trusted publishing.
• 📦 Automated building and publishing steps to PyPI in the GitHub Actions workflow.
• 🔄 Version updated from 0.1.9 to 0.1.10 in pyproject.toml.
• 📧 Updated contact information from website links to email addresses in the project metadata.
• 🔧 Added error resilience in GitHub Actions to allow continued execution despite publish-related errors.

🎯 Purpose & Impact

• 🚀 Improves security and efficiency in deploying updates to PyPI, making package distribution more robust and streamlined.
• 📈 Facilitates better version management and reduces manual input for developers, enhancing operational efficiency.
• 📧 Simplifies user communication by providing direct email contacts for project authors and maintainers.
• 🤖 Ensures a smoother, automated release process by handling potential workflow errors gracefully, minimizing disruptions.

What's Changed

• Update pyproject.toml emails by @glenn-jocher in #99
• Update publish.yml by @glenn-jocher in #100
• Update publish.yml to trusted publisher by @glenn-jocher in #103

Full Changelog: v0.1.9...v0.1.10

v0.1.9 - Use author website in pyproject.toml (#98)

🌟 Summary

Version 0.1.9 introduces improvements to metadata and contact information across project files, bolstering accessibility and transparency.

📊 Key Changes

• Version Update: Transitioned the plugin from version 0.1.8 to 0.1.9.
• License Specification: Updated the license description to AGPL-3.0 for clarity.
• Author and Maintainer Details: Replaced email contacts with website links for both authors and maintainers, enhancing accessibility.
• Metadata Enhancements:
  • Added project URLs for Homepage, Source, Documentation, and Changelog.
  • Bumped Slack-GitHub Action version to 1.27.0, enhancing Slack notification capabilities.

🎯 Purpose & Impact

• Clarity and Compliance: Clearer license information aligns with open-source norms, ensuring legal clarity for users. 📜
• Improved Accessibility: Direct links to author/maintainer websites and project resources make navigation easier for users, facilitating greater engagement and support. 🔗
• Enhanced Communication: Updated Slack action improves how automatically generated notifications are handled, especially with new custom payload settings. 📬
• User Experience: Streamlined access to project documentation and updates enhances user interaction, making it easier to find necessary information and support. 🌐

What's Changed

• Bump slackapi/slack-github-action from 1.26.0 to 1.27.0 in /.github/workflows by @dependabot[bot] in #95
• Update pyproject.toml project URLs by @glenn-jocher in #97
• Use author website in pyproject.toml by @glenn-jocher in #98

New Contributors

• @dependabot[bot] made their first contribution in #95

Full Changelog: v0.1.8...v0.1.9

v0.1.8 - Update pyproject.toml to v0.1.8 (#93)

🌟 Summary

Release v0.1.8 introduces minor updates primarily focused on labeling adjustments and improvements in publication processes, along with community engagement enhancements.

📊 Key Changes

• 📜 GitHub Actions Update: Modified the naming conventions for version tags in automation scripts within the GitHub Actions workflow.
• 💬 Community Expansion: Added a Reddit link to the README for broader community engagement.
• 🗂 Version Bump: Updated the plugin version from 0.1.7 to 0.1.8.

🎯 Purpose & Impact

• 🏷 Enhanced Consistency: Changing tag references in workflows helps streamline the release process, ensuring clarity and consistency in labeling, which is crucial for version tracking and management.
• 🌐 Community Growth: By including a Reddit link, users are offered more platforms for discussion and support, fostering a larger and more interactive community.
• 🔄 Smooth Transitions: Incrementing the plugin version indicates updates and improvements, prompting users to adopt the latest version with potential bug fixes and optimizations.

v0.1.7 - Update pyproject.toml to v0.1.7 (#89)

🌟 Summary

The v0.1.7 update focuses on optimizing performance and streamlining the release workflow of the Ultralytics MkDocs plugin.

📊 Key Changes

• Optimize Avatar Sizes: Improved the sizing of avatars in documentation 💾.
• Update Publish Workflow: Simplified the workflow by removing unnecessary components and dependencies, specifically eliminating the use of OpenAI API and other Python packages from the publish.yml script 🛠️.
• Version Update: Incremented version in the pyproject.toml file to 0.1.7 📈.

🎯 Purpose & Impact

• Performance Improvement: By optimizing avatar sizes, the documentation pages may load faster, improving the user experience for readers 📚.
• Streamlined Development: The revised publishing workflow reduces complexity, which can help maintainers update the repository and publish new versions more efficiently, saving time and resources ⏳.
• Transparency & Manageability: By simplifying the scripts, it becomes easier for developers to understand and maintain the workflow, potentially reducing bugs and issues during deployments 🔍.

What's Changed

• Update publish.yml by @glenn-jocher in #88
• Update pyproject.toml to v0.1.7 by @glenn-jocher in #89

Full Changelog: v0.1.6...v0.1.7

v0.1.6 - Optimize avatar sizes (#87)

🌟 Summary

The v0.1.6 release of the MkDocs Ultralytics Plugin introduces enhanced functionality for GitHub integration and updates to maintain compatibility with the latest tools and APIs.

📊 Key Changes

• GitHub Avatar Support: Added avatar support to display authors' profile images from GitHub in documentation.
• Updated GPT Model: Modified the chat model in workflows to gpt-4o-2024-08-06.
• GitHub API Enhancements: Improved methods to extract GitHub usernames and avatars using more efficient API calls.
• Documentation Update: Added a Reddit badge to the README for enhanced community engagement.

🎯 Purpose & Impact

• Enhanced User Experience: 👤 Showing authors' avatars directly in the documentation improves readability and engagement by personalizing contributions.
• Improved Accuracy: ⚙️ Updating how GitHub usernames and avatars are retrieved ensures more reliable and up-to-date contributor information.
• Keeping Up with Technology: 🚀 By upgrading to a newer GPT model, the workflows can take advantage of more advanced language processing features.
• Community Engagement: 🌐 Adding the Reddit badge makes it easier for users to connect and engage with the Ultralytics community, fostering interaction and support.

These updates collectively enhance the usability and community aspects of projects using the MkDocs Ultralytics Plugin.

What's Changed

• Update publish.yml to GPT4o-08-06 by @glenn-jocher in #83
• Update publish.yml to use gh by @glenn-jocher in #84
• Add https://www.reddit.com/r/Ultralytics/ badge by @glenn-jocher in #85
• Optimize avatar sizes by @glenn-jocher in #87

Full Changelog: v0.1.5...v0.1.6