Skip to content

Add comprehensive release process documentation#60

Merged
vhaasteren merged 9 commits into
nanograv:masterfrom
vhaasteren:make-release
Oct 24, 2025
Merged

Add comprehensive release process documentation#60
vhaasteren merged 9 commits into
nanograv:masterfrom
vhaasteren:make-release

Conversation

@vhaasteren
Copy link
Copy Markdown
Member

@vhaasteren vhaasteren commented Oct 22, 2025

Summary

This PR adds detailed documentation for the PTMCMCSampler release process, which was previously undocumented and relied on institutional knowledge.

Changes Made

  • Added RELEASE.md: Comprehensive release documentation including:
    • Step-by-step release process (GitHub release + conda feedstock update)
    • Prerequisites and troubleshooting information
    • Release checklist and example commands
    • Explanation of setuptools_scm version management
  • Updated README.md: Added "For Maintainers" section with link to release documentation

Release Process Documented

  • Manual GitHub release creation (triggers automated PyPI upload)
  • Manual conda feedstock updates in conda-forge repository
  • Version management via setuptools_scm (automatic from git tags)
  • Troubleshooting for common issues

Benefits

  • Clear, documented process for all maintainers
  • Reduced dependency on specific individuals
  • Consistent release procedures
  • Easier onboarding of new maintainers

@vhaasteren vhaasteren linked an issue Oct 22, 2025 that may be closed by this pull request
@kdolum
Copy link
Copy Markdown
Collaborator

kdolum commented Oct 22, 2025

Looks fine to me, but the proof of the pudding is in going through the steps as if you didn't know what you were doing and seeing that everything works. Also in #61 you propose to change the way that this works, so do you want to wait until that is done and update this documentation?

@vhaasteren
Copy link
Copy Markdown
Member Author

Thanks! And that is exactly what I am doing right now. If it all works I'll push my updates to this branch. I have some already, so don't merge until it is all there

@vhaasteren
Copy link
Copy Markdown
Member Author

@kdolum

I think that #61 is separate, and can wait. That's more work. I did just verify the current release process works (just did it), and I updated the feedstock and main repositories. I think this PR (#60) is now ready and verified.

Copy link
Copy Markdown
Collaborator

@AaronDJohnson AaronDJohnson left a comment

Choose a reason for hiding this comment

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

Looks good to me.

@vhaasteren vhaasteren merged commit dd837f9 into nanograv:master Oct 24, 2025
10 checks passed
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.

Add comprehensive release process documentation

3 participants