Skip to content

v0.2.5 - Resolve GitHub authors from commit metadata

Latest
Latest

Choose a tag to compare

View all tags
@github-actions github-actions released this 30 Jun 09:06
· 15 commits to main since this release
v0.2.5
ad77eff
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

🌟 Summary

v0.2.5 brings a useful docs-plugin update with better AI-friendly site indexing 🤖, more reliable author handling and Safari clipboard support 🍎, plus cleaner Slack release notifications with clickable PR links 🔗.

📊 Key Changes

  • 🔗 Slack publish notifications now link PR numbers automatically

    • The latest PR, by @glenn-jocher, turns PR references like #123 in release titles into clickable GitHub links inside the successful Publish to PyPI Slack message.
    • This builds on the earlier notification cleanup, making release alerts faster to understand and easier to navigate.

  • 🤖 New llms.txt generation support

    • The plugin can now automatically generate an llms.txt file after site builds.
    • A new config option, add_llms_txt, is included and enabled by default.
    • README docs were also updated to explain this feature.

  • 🍎 Safari fix for “Copy for LLM”

    • The Copy page in Markdown format button now works better in Safari.
    • The clipboard handling was updated to use a more compatible browser approach.

  • 👤 More reliable GitHub author resolution

    • Author lookup was improved to avoid race conditions during parallel site processing.
    • The plugin now resolves authors earlier and more safely.
    • It also adds a smarter fallback using commit metadata when direct GitHub user lookup is incomplete.

  • 🩹 Regression fix for author processing

    • A bug introduced in the earlier author-handling refactor was fixed.
    • This prevents crashes when certain metadata features such as author info or JSON-LD are enabled.

  • 🧾 Documentation and metadata improvements

    • README links were cleaned up and corrected.
    • Plugin docstrings were added for better maintainability.
    • Internal git history parsing was improved to track commit IDs alongside author emails.

  • ⚙️ CI/CD workflow maintenance

    • Several GitHub Actions were updated, including:
      • actions/checkout
      • actions/upload-artifact
      • actions/download-artifact
      • slackapi/slack-github-action
    • setup-uv was briefly bumped, then corrected back to a valid working version.

🎯 Purpose & Impact

  • 🚀 Faster release visibility for maintainers

    • The clickable PR links in Slack notifications make it much easier for teams to jump from a release alert straight to the underlying PR.
    • This is mainly a workflow improvement, but it reduces friction for anyone monitoring releases.

  • 🤖 Better discoverability for AI tools

    • The new llms.txt feature helps AI systems and LLM-based tools better understand and navigate documentation sites.
    • For teams publishing docs, this can improve how their content is consumed by modern AI assistants and indexing systems.

  • 🌍 Better browser compatibility for end users

    • Safari users should now have a smoother experience when copying page content for AI or Markdown reuse.
    • This makes the docs more accessible across browsers.

  • 🛡️ Improved build stability

    • The author-resolution fixes reduce failures and inconsistent behavior during site generation.
    • This is especially valuable for larger doc sites or automated builds.

  • 🧑‍💻 Safer and more maintainable plugin behavior

    • Fixing the regression and improving internal metadata handling means fewer unexpected build-time errors.
    • Contributors also benefit from clearer docs and code comments.

  • 📦 Minimal user-facing disruption

    • Most changes improve the documentation plugin, release workflow, and reliability rather than changing public APIs in a major way.
    • For most users, v0.2.5 should feel like a more polished and dependable release ✅

What's Changed

Full Changelog: v0.2.4...v0.2.5

Contributors

glenn-jocher, dependabot, and 3 other contributors
Assets 3
Loading