Skip to content
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

Add a PLEP on release schedule #43

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

Conversation

namurphy
Copy link
Member

This PR is to create a PLEP that defines a regular release schedule (January, May, and September of each year) and an LTS policy.

This isn't urgent at all, so there's no need to review it yet. In particular, we don't have a strong need for LTS releases yet, so it'd probably be best to delay thinking about this for a while.

Comment on lines +62 to +67
To implement this PLEP, it will be necessary to implement
infrastructure for performing backports for LTS releases. For example,
when a pull request for Astropy is labeled as appropriate for a
backport, then a GitHub tool will automatically create a pull request
to the appropriate branches. This infrastructure will reduce the
effort needed to perform backports and minor releases.
Copy link
Member Author

Choose a reason for hiding this comment

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

We should probably delay a decision on an LTS policy until we have better infrastructure in place to do backports. I want to look into how Astropy and other packages have backports set up too.

@namurphy
Copy link
Member Author

pre-commit.ci autofix

@namurphy
Copy link
Member Author

namurphy commented May 24, 2023

There has just been an Astropy Proposal for Enhancement that would end Astropy's practice of doing LTS releases. Essentially, Astropy has achieved enough stability that LTS releases aren't really that beneficial. Plus, LTS releases are not standard practice in the scientific pythoniverse. So, unless we have a strong use case and sufficient resources, it seems like we should learn from Astropy and not do LTS releases.

Comment on lines +1 to +3
=========================================================
PLEP-0009 – Release schedule and long-term support policy
=========================================================
Copy link
Member Author

Choose a reason for hiding this comment

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

Suggested change
=========================================================
PLEP-0009 – Release schedule and long-term support policy
=========================================================
============================
PLEP-0009 – Release schedule
============================

Comment on lines +27 to +28
This PLEP describes the nominal release schedule and long-term support
(LTS) policy for PlasmaPy.
Copy link
Member Author

Choose a reason for hiding this comment

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

Suggested change
This PLEP describes the nominal release schedule and long-term support
(LTS) policy for PlasmaPy.
This PLEP describes the nominal release schedule for PlasmaPy.

Comment on lines +51 to +57
Long-term support policy
------------------------

If there is sufficient funding for the development and maintenance of
PlasmaPy, then the first release in even-numbered years will be an LTS
release that will be maintained with bugfixes and documentation
improvements for two years.
Copy link
Member Author

Choose a reason for hiding this comment

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

Suggested change
Long-term support policy
------------------------
If there is sufficient funding for the development and maintenance of
PlasmaPy, then the first release in even-numbered years will be an LTS
release that will be maintained with bugfixes and documentation
improvements for two years.
No designated long-term support releases
----------------------------------------
PlasmaPy will not designate any releases as long-term support (LTS)
releases. Packages that depend on PlasmaPy should perform cron tests
using the `main` branch of PlasmaPy's repository.

users, and more difficulty keeping track of citations.

A release cadence of four months balances these tradeoffs.

Copy link
Member Author

Choose a reason for hiding this comment

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

Need to add a section that addresses the alternative of having LTS releases.

@namurphy namurphy changed the title Add a PLEP on release schedule and long-term support policy Add a PLEP on release schedule May 24, 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.

1 participant