Skip to content

docs: auto-inject release dates from git tags#1737

Merged
cpcloud merged 1 commit intoNVIDIA:mainfrom
cpcloud:release-notes-date-stamp
Mar 7, 2026
Merged

docs: auto-inject release dates from git tags#1737
cpcloud merged 1 commit intoNVIDIA:mainfrom
cpcloud:release-notes-date-stamp

Conversation

@cpcloud
Copy link
Contributor

@cpcloud cpcloud commented Mar 7, 2026

Summary

  • Adds a small Sphinx extension (release_date) that automatically injects "Released on" dates into release notes pages at doc build time, derived from git tags.
  • No workflow changes, no new dependencies -- just a ~90-line extension in the existing cuda_python/docs/exts/ directory, registered in all four packages' conf.py.

How it works

When you write a new release notes file like cuda_core/docs/source/release/0.8.0-notes.rst, just write the content -- skip the "Released on" line entirely. When the docs build runs after the git tag exists, the extension sees the filename 0.8.0-notes, looks up cuda-core-v0.8.0 in git, grabs the tag's creation date, and injects the date into the rendered output automatically.

  • No tag yet (still in development) → no date shown
  • Tag exists → date appears in the built docs
  • File already has a manual "Released on" line → extension leaves it alone

That last point means this is backward compatible with all existing release notes that already have manually written dates.

@copy-pr-bot
Copy link
Contributor

copy-pr-bot bot commented Mar 7, 2026

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

@cpcloud cpcloud force-pushed the release-notes-date-stamp branch 3 times, most recently from 3839b9f to 2a19401 Compare March 7, 2026 00:31
@cpcloud cpcloud requested a review from rwgk March 7, 2026 00:35
@cpcloud
Copy link
Contributor Author

cpcloud commented Mar 7, 2026

/ok to test

@copy-pr-bot
Copy link
Contributor

copy-pr-bot bot commented Mar 7, 2026

/ok to test

@cpcloud, there was an error processing your request: E1

See the following link for more information: https://docs.gha-runners.nvidia.com/cpr/e/1/

@cpcloud cpcloud force-pushed the release-notes-date-stamp branch from 2a19401 to 1aa9c31 Compare March 7, 2026 00:42
@copy-pr-bot
Copy link
Contributor

copy-pr-bot bot commented Mar 7, 2026

Auto-sync is disabled for ready for review pull requests in this repository. Workflows must be run manually.

Contributors can view more details about this message here.

@cpcloud
Copy link
Contributor Author

cpcloud commented Mar 7, 2026

/ok to test

Copy link
Collaborator

@rwgk rwgk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wow, coool!

Release notes no longer need a manual "Released on" line. The new
release_date extension derives the date from the git tag at doc build
time and injects it into the RST source for any release-notes page
that doesn't already have one.

Made-with: Cursor
@cpcloud cpcloud force-pushed the release-notes-date-stamp branch from 1aa9c31 to 83e75e0 Compare March 7, 2026 01:45
@cpcloud
Copy link
Contributor Author

cpcloud commented Mar 7, 2026

/ok to test

@github-actions

This comment has been minimized.

@cpcloud cpcloud enabled auto-merge (squash) March 7, 2026 02:17
@cpcloud cpcloud merged commit 730a3e2 into NVIDIA:main Mar 7, 2026
86 checks passed
@github-actions
Copy link

github-actions bot commented Mar 7, 2026

Doc Preview CI
Preview removed because the pull request was closed or merged.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants