Skip to content

v0.1.16 - Add default author feature (#125)

Compare
Choose a tag to compare
@github-actions github-actions released this 29 Jan 18:58
· 1 commit to main since this release
8f7d73b

🌟 Summary

The v0.1.16 release introduces enhanced metadata customization for the Ultralytics MkDocs plugin, emphasizing fallback support for author data and handling missing Git history, while also implementing other minor updates for workflow clarity and code standardization.


📊 Key Changes

  • Default Author Support:
    Added a default_author config option to specify a fallback GitHub author email for files without author metadata.
  • Git Data Fallbacks:
    Introduced constants for creation and modification dates to ensure metadata availability when Git history is incomplete.
  • Formatting Workflow Improvements:
    Updated .github/workflows/format.yml to improve token handling and formatting of multiple file types like Python, YAML, and Markdown.
  • License Consistency:
    Standardized license headers across Python, YAML, TOML files, linking to the Ultralytics AGPL-3.0 License page.
  • Dependency Upgrade:
    Bumped astral-sh/setup-uv from v4 to v5 for workflow enhancements, including caching support for efficiency.

🎯 Purpose & Impact

  • Enhanced Documentation Reliability 📚:
    The default_author enables accurate author attribution, even when Git metadata is incomplete, improving documentation consistency.
  • Improved Metadata Handling ⚙️:
    Default fallback dates strengthen workflows where Git history lacks sufficient information, ensuring smoother documentation builds.
  • Cleaner and Standardized Codebase 🧹:
    Updated license headers and formatting workflows help contributors adhere to consistent styles and legal requirements, enhancing overall project clarity.
  • Efficient Contributor Experience 🚀:
    Workflow improvements reduce potential errors, ensuring a seamless experience for developers and maintainers alike.

This release focuses on bolstering metadata capabilities for documentation, enforcing consistency across files, and streamlining development workflows.

What's Changed

Full Changelog: v0.1.15...v0.1.16