Repository navigation
ci: tag main at each datajoint-python release - #303
Open
dimitri-yatsenko wants to merge 1 commit into
Open
dimitri-yatsenko wants to merge 1 commit into
dimitri-yatsenko wants to merge 1 commit into
Conversation
A daily workflow tags main with vX.Y.Z at the last commit before each datajoint-python release was published, so the docs as they stood when a version shipped can be recovered. The first run backfills v2.0.0 onward.
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds tags to this repo that match datajoint-python releases. Each
vX.Y.Ztag marks the last commit onmainat the moment that library version was published, so the docs as they stood when a version shipped can always be recovered (git checkout v2.3.4). It also lays the groundwork for versioned docs later, if wanted.scripts/tag_library_releases.pyreads the published datajoint-python releases (drafts and pre-releases excluded) and tagsmainatgit rev-list -1 --first-parent --before=<published_at> origin/main. It never moves an existing tag, so reruns are safe.--dry-runprints the mapping..github/workflows/tag-library-releases.ymlruns it daily and on demand. Tag placement depends only on the publish time, so a daily schedule loses nothing, and it needs no cross-repo token. The first run after merge backfills.maindocumented the newer line when they shipped.A tag is a snapshot taken at release time, not a promise that the docs match that version exactly:
maincan be ahead of or behind the library.Backfill (dry run against current history)
Test plan
--dry-runlocally produces the table above; v2.3.4 lands on "docs: what's new in 2.3.4" (What's new in 2.3.4 #289), merged three minutes before the library release.workflow_dispatchand confirm the 15 tags appear.