Skip to content

release: add release notes guidance and cache tag tests - #139

Merged
guillon merged 2 commits into
xtc-tools:mainfrom
guillon:dev/cguillon/release-note
Sep 17, 2026
Merged

guillon merged 2 commits into
xtc-tools:mainfrom
guillon:dev/cguillon/release-note

Conversation

@guillon

@guillon guillon commented Sep 10, 2026

Copy link
Copy Markdown
Member

Motivation

Provide a consistent process for preparing GitHub release notes and avoid rerunning tests when a release tag points to a Git tree that has already passed CI.

Description

Add a Jinja2 release-note template covering important features, fixes, merged pull requests, and new contributors.

Document how to collect changes between tags, review generated Markdown, and publish release notes with the GitHub CLI.

Enable Git-tree-based test-result cache lookup and publication for tag builds. Package building, validation, and publication remain uncached.

Commits

  • docs: add release notes template and guidance
  • ci: enable test result cache for tags

Discussion

The tag test cache uses the same Git tree, operating system, and Python-version identity as branch and pull-request builds.

Testing:

  • actionlint .github/workflows/xtc-tests.yml
  • git diff --check

TODO:

  • No outstanding work identified.

@guillon
guillon requested a review from qaco September 10, 2026 15:37
@guillon guillon added the documentation Improvements or additions to documentation label Sep 10, 2026
@codecov

codecov Bot commented Sep 10, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@guillon
guillon force-pushed the dev/cguillon/release-note branch from e7db65d to fa0a4be Compare September 11, 2026 10:26
@guillon guillon changed the title docs: add release notes template and guidance release: add release notes guidance and cache tag tests Sep 11, 2026
@guillon guillon assigned guillon and unassigned qaco Sep 17, 2026
@guillon

guillon commented Sep 17, 2026

Copy link
Copy Markdown
Member Author

@qaco merging it, you may comment later.

@guillon
guillon merged commit 782f203 into xtc-tools:main Sep 17, 2026
10 checks passed
@guillon
guillon deleted the dev/cguillon/release-note branch September 17, 2026 11:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants