-
-
Notifications
You must be signed in to change notification settings - Fork 1.8k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Updated release procedure to no longer mention LTS (as per APE 21) #14713
Conversation
Thank you for your contribution to Astropy! 🌌 This checklist is meant to remind the package maintainers who will review this pull request of some common things to look for.
|
👋 Thank you for your draft pull request! Do you know that you can use |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks!
docs/development/releasing.rst
Outdated
#. If this is a release of the current release (i.e., not an LTS supported along | ||
side a more recent version), update the "stable" branch to point to the new | ||
release:: | ||
#. Update the "stable" branch to point to the new release:: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we still need stable branch?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No I think we can remove this if we set up the automatic updating of stable on RTD
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It sounds like this should work by default but I guess we will need to remove the stable branch in our repo and probably also wipe stable in RTD after we've done that and remove the explicitly specified stable version.
|
||
$ git checkout stable | ||
$ git reset --hard v<version> | ||
$ git push upstream stable --force | ||
|
||
#. If this is an LTS release (whether or not it is being supported alongside |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Does this mean we delete the LTS branch from repo after APE 21 is accepted?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No because we might break old links I think? We can just leave the branch frozen?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Don't we need the stable branch for RTD ? (https://docs.astropy.org/en/stable/)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In my projects without a stable
branch, the "stable" on RTD automagically picks up the latest release. 🤷
Do you plan to delete the stable
branch altogether?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Right, then we should delete the stable branch.
https://docs.readthedocs.io/en/stable/versions.html
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When should I do that? Now or when you cut v6.0 ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hmm yeah we can probably do that now.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done. stable
is gone.
Typically, you should wait to make sure ``conda-forge`` and possibly | ||
``conda`` works before sending out the public announcement | ||
(so that users who want to try out the new version can do so with ``conda``). | ||
merge. When the ``conda-forge`` package is ready, email the Anaconda |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Anything else will change on the conda side without LTS, @mwcraig ?
docs/index.rst
Outdated
@@ -182,7 +182,6 @@ Project details | |||
:maxdepth: 1 | |||
|
|||
whatsnew/index | |||
lts_policy |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we want to keep this page but on that page link to APE 21 and tell people that LTS is no more?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes we could do this, will update
@astrofrog , can you please rebase and take this out of draft? APE 21 is accepted. |
2e863e3
to
f764111
Compare
@pllim - done! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I noticed one discrepancy between the changes from astropy/astropy-APEs#82 and the changes here
@astrofrog , please rebase. Thanks! |
@astrofrog , any chance you can wrap this up soon? 🙏 |
Will do on Monday |
…elease numbers for the first feature release in each cycle
Co-authored-by: P. L. Lim <2090236+pllim@users.noreply.github.com>
f764111
to
4943808
Compare
4943808
to
9f2a18e
Compare
Co-authored-by: William Jamieson <wjamieson@stsci.edu>
Rebased - someone should read over the changes carefully once more to be sure that this is all fine now. |
@saimn would be the best person, but @WilliamJamieson also requested changes before. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sounds good to me!
This is a companion to astropy/astropy-APEs#82 which proposes no longer having LTS releases.
As part of APE 21 we are also advocating using x.x.0 version number formats for the first minor/major release in each cycle as this is more standard practice (the only place where I think we can keep the x.x version numbers is for the filenames and titles of the What's new pages)