Skip to content

Updated release procedure to no longer mention LTS (as per APE 21) - #14713

Merged
saimn merged 5 commits into
astropy:mainfrom
astrofrog:docs-remove-lts
Oct 28, 2023
Merged

saimn merged 5 commits into
astropy:mainfrom
astrofrog:docs-remove-lts

Conversation

@astrofrog

Copy link
Copy Markdown
Member

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)

@github-actions

Copy link
Copy Markdown
Contributor

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.

  • Do the proposed changes actually accomplish desired goals?
  • Do the proposed changes follow the Astropy coding guidelines?
  • Are tests added/updated as required? If so, do they follow the Astropy testing guidelines?
  • Are docs added/updated as required? If so, do they follow the Astropy documentation guidelines?
  • Is rebase and/or squash necessary? If so, please provide the author with appropriate instructions. Also see "When to rebase and squash commits".
  • Did the CI pass? If no, are the failures related? If you need to run daily and weekly cron jobs as part of the PR, please apply the "Extra CI" label. Codestyle issues can be fixed by the bot.
  • Is a change log needed? If yes, did the change log check pass? If no, add the "no-changelog-entry-needed" label. If this is a manual backport, use the "skip-changelog-checks" label unless special changelog handling is necessary.
  • Is this a big PR that makes a "What's new?" entry worthwhile and if so, is (1) a "what's new" entry included in this PR and (2) the "whatsnew-needed" label applied?
  • Is a milestone set? Milestone must be set but we cannot check for it on Actions; do not let the green checkmark fool you.
  • At the time of adding the milestone, if the milestone set requires a backport to release branch(es), apply the appropriate "backport-X.Y.x" label(s) before merge.

@github-actions

Copy link
Copy Markdown
Contributor

👋 Thank you for your draft pull request! Do you know that you can use [ci skip] or [skip ci] in your commit messages to skip running continuous integration tests until you are ready?

@pllim pllim added this to the v6.0 milestone Apr 29, 2023

@pllim pllim left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks!

Comment thread docs/development/releasing.rst Outdated
Comment thread docs/development/releasing.rst Outdated
Comment thread docs/development/releasing.rst Outdated
Comment thread docs/development/releasing.rst Outdated
Comment thread 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::

Copy link
Copy Markdown
Member

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?

Copy link
Copy Markdown
Member Author

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

Copy link
Copy Markdown
Member Author

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 reset --hard v<version>
$ git push upstream stable --force

#. If this is an LTS release (whether or not it is being supported alongside

Copy link
Copy Markdown
Member

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?

Copy link
Copy Markdown
Member Author

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?

Copy link
Copy Markdown
Contributor

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/)

Copy link
Copy Markdown
Member

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?

Copy link
Copy Markdown
Contributor

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

Copy link
Copy Markdown
Member

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 ?

Copy link
Copy Markdown
Contributor

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.

Copy link
Copy Markdown
Member

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

Copy link
Copy Markdown
Member

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 ?

Comment thread docs/index.rst Outdated
:maxdepth: 1

whatsnew/index
lts_policy

Copy link
Copy Markdown
Member

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?

Copy link
Copy Markdown
Member Author

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

@pllim

pllim commented May 31, 2023

Copy link
Copy Markdown
Member

@astrofrog , can you please rebase and take this out of draft? APE 21 is accepted.

@pllim pllim changed the title Updated release procedure to no longer mention LTS Updated release procedure to no longer mention LTS (as per APE 21) May 31, 2023
@astrofrog
astrofrog marked this pull request as ready for review June 1, 2023 15:53
@astrofrog

Copy link
Copy Markdown
Member Author

@pllim - done!

@pllim pllim left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks!

@pllim
pllim enabled auto-merge June 1, 2023 15:55
@pllim
pllim disabled auto-merge June 1, 2023 16:08

@WilliamJamieson WilliamJamieson left a comment

Copy link
Copy Markdown
Contributor

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

Comment thread docs/development/releasing.rst Outdated
Comment thread docs/lts_policy.rst
@pllim

pllim commented Oct 4, 2023

Copy link
Copy Markdown
Member

@astrofrog , please rebase. Thanks!

@pllim

pllim commented Oct 27, 2023

Copy link
Copy Markdown
Member

@astrofrog , any chance you can wrap this up soon? 🙏

@astrofrog

Copy link
Copy Markdown
Member Author

Will do on Monday

astrofrog and others added 2 commits October 27, 2023 21:08
…elease numbers for the first feature release in each cycle
Co-authored-by: William Jamieson <[email protected]>
@astrofrog

Copy link
Copy Markdown
Member Author

Rebased - someone should read over the changes carefully once more to be sure that this is all fine now.

@pllim

pllim commented Oct 27, 2023

Copy link
Copy Markdown
Member

@saimn would be the best person, but @WilliamJamieson also requested changes before.

@saimn saimn left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Sounds good to me!

@saimn
saimn dismissed WilliamJamieson’s stale review October 28, 2023 20:40

Request was addressed.

@saimn
saimn merged commit 1a1b689 into astropy:main Oct 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants