Skip to content

docs: improve release process documentation#3508

Merged
andygrove merged 1 commit intoapache:mainfrom
andygrove:improve-release-docs
Feb 12, 2026
Merged

docs: improve release process documentation#3508
andygrove merged 1 commit intoapache:mainfrom
andygrove:improve-release-docs

Conversation

@andygrove
Copy link
Member

Summary

  • Add a quick-reference checklist at the top of the document
  • Add a release preparation section covering expression support review
  • Make version numbers consistent throughout (using 0.13.0 as the example release)
  • Add prerequisites for create-tarball.sh (GPG key, SVN credentials, Python requests package)
  • Add link to verification guide and verify-release-candidate.sh script
  • Add guidance for when a vote fails (increment RC number, repeat from tagging)
  • Add announcement email content guidance
  • Clean up /comet:$ prompt artifacts in publish-to-maven.sh examples
  • Consolidate "Post Release Admin" and "Post Release Activities" into a single "Post Release" section
  • Remove outdated "Publishing Crates" section
  • Remove "Update released version number in documentation" section (now dynamic)
  • Clarify that some tasks require PMC membership while preparation tasks are open to any contributor

Test plan

  • Verify the document renders correctly in the docs build
  • Review all version number references for consistency

🤖 Generated with Claude Code

@andygrove
Copy link
Member Author

@comphead I added some notes on checking that documentation is up to date before starting the release process, based on your suggestion.

- Add quick-reference checklist at the top
- Add release preparation section for reviewing expression support
- Make version numbers consistent throughout (using 0.13.0 as example)
- Add prerequisites for create-tarball.sh (GPG, SVN, Python)
- Add verification guide link and vote failure guidance
- Add announcement email guidance
- Clean up /comet:$ prompt artifacts in examples
- Consolidate post-release sections
- Remove outdated "Publishing Crates" and "Update version in docs" sections
- Clarify contributor vs PMC member responsibilities

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@andygrove andygrove force-pushed the improve-release-docs branch from 4331919 to a5a9623 Compare February 12, 2026 21:09
performed by any contributor, while certain release tasks can only be performed by a DataFusion Project Management
Committee (PMC) member.

## Checklist
Copy link
Contributor

Choose a reason for hiding this comment

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

we should probably mention that commands to execute checklist items are below.

btw to avoid chasing versions WDYT if we have template for this doc, where we would define current_version and next_version and script that generates actual md file replacing current_version and next_version with actual values 0.13, 0.14?

Copy link
Member Author

Choose a reason for hiding this comment

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

oops, missed this comment ... 0.13.0 is just used as an example - no need to update this each time. Previously there was a mix of versions, so it was confusing.

We do have something like $COMET_VERSION substitution already in docs.

Copy link
Contributor

@comphead comphead left a comment

Choose a reason for hiding this comment

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

Thanks @andygrove

@andygrove andygrove merged commit 2baa434 into apache:main Feb 12, 2026
1 check passed
@andygrove andygrove deleted the improve-release-docs branch February 12, 2026 21:24
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