Add PLEP 8 on switching to calendar versioning #39

namurphy · 2022-11-22T20:41:11Z

This PR follows up on a discussion in #38 and elsewhere in the plasmapythoniverse about switching from semantic versioning to date-based versioning. There's a discussion of the tradeoffs in #38.

I'm basing the scheme in the first draft on Ubuntu's, which has versions like 22.04 and 22.10, which were the releases from April and October 2022. The year format is concise, and it's more clear with the zero-padded month that it actually represents a month. (I got confused earlier today with pip v21.3, since I thought that the minor version number meant the month when it actually didn't.)

This new PLEP would repeal PLEP 5, but since it's a complete rewrite, I decided on doing a new PLEP so as to make the history more apparent.

Closes #38.

PLEP-0008.rst

README.rst

PLEP-0008.rst

rocco8773 · 2022-12-08T20:43:57Z

PLEP-0008.rst

+-------------------+---------------------------------------------+
+| status            | discussion                                  |
+-------------------+---------------------------------------------+
+| DOI               |                                             |


update with reserved DOI

PLEP-0008.rst

rocco8773 · 2022-12-08T20:55:22Z

PLEP-0008.rst

+Advantages of adopting calendar versioning
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+* The age of a release can be gauged directly from the version number.


Not sure the best way to make the comment, but also easier to traceback the version when cited in a journal article.

PLEP-0008.rst

rocco8773

A section of our strategy for a long-term support version.

A comment on how the proposed version scheme is better suited to a perpetual-development package like PlasmaPy.

Co-authored-by: Erik Everson <[email protected]>

PLEP-0008.rst

StanczakDominik · 2022-12-12T19:30:11Z

I'd just like to bring dask/community#100 (comment) to your attention on the zero-padding discussion! The important points:

20.01.01 / 2020.01.01 are valid PEP 440 versions.

Overall, the choice between 0Y/0M/0D vs YY/MM/DD is purely a aesthetic one -- either will work with basically every Python Packaging tool that follows the standards.

I'm weakly in favor of zero-padding, but don't mind much either way.

and then they went ahead and removed the zero-padding in dask/community#249, so I'm now all for going padless.

Co-authored-by: Dominik Stańczak-Marikin <[email protected]>

namurphy · 2022-12-14T21:53:39Z

I decided against discussing our LTS strategy since we don't have plans to do that in the near future, and I'd rather have a separate PLEP on that which we can do when we decide to do the LTS releases.

Other than that, I think I addressed all suggestions. @rocco8773 — if this looks good to you, please feel free to merge.

PLEP-0005.rst

namurphy · 2023-01-10T19:15:19Z

PLEP-0000.rst

+========+=====================================+========================+============+===========================+
+| 5      | `PlasmaPy Versioning and Releases`_ | Nicholas A. Murphy and | process    | `10.5281/zenodo.1451974`_ |
+|        |                                     | Stuart J. Mumford      |            |                           |
+--------+--------------------------------------+------------------------+-----------+---------------------------+


Need to fix table!

rocco8773 · 2023-01-10T19:15:37Z

PLEP-0005.rst

@@ -257,3 +260,5 @@ Semantic versioning is a well-defined versioning scheme that provides
 users with useful information about whether or not there were any
 backward incompatible changes.  This scheme is well-suited to a core
 scientific software package that will require stability.
+
+.. |PLEP 8| replace:: https://github.com/PlasmaPy/PlasmaPy-PLEPs/blob/main/PLEP-0007.rst


Suggested change

.. |PLEP 8| replace:: https://github.com/PlasmaPy/PlasmaPy-PLEPs/blob/main/PLEP-0007.rst

.. |PLEP 8| replace:: https://github.com/PlasmaPy/PlasmaPy-PLEPs/blob/main/PLEP-0008.rst

rocco8773 · 2023-01-10T19:39:51Z

PLEP-0008.rst

+.. note::
+
+    This PLEP supersedes |PLEP 5|, which is no longer in effect.


[optional change] admonitions don't get stylized with GitHub rendering

rocco8773 · 2023-01-10T19:45:02Z

README.rst

@@ -38,3 +38,6 @@ convenience, an abbreviated index of PLEPs is provided below.
 | 7      | `Structure of Top-Level Sub-Packages <./PLEP-0007.rst>`__                        | .. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.3774573.svg |
 |        |                                                                                  |    :target:  http://doi.org/10.5281/zenodo.3774573                 |
 +--------+----------------------------------------------------------------------------------+--------------------------------------------------------------------+
+| 8      | `Calendar Versioning <./PLEP-0008.rst>`__                                        |                                                                    |


Do we have a DOI to put here now?

rocco8773 · 2023-01-10T19:46:40Z

PLEP-0000.rst

+--------+--------------------------------------------------------------+----------------------+------------+---------------------------+
+| 6      | `A New General-Purpose Plasma Object`_                       | Andrew J. Leonard    | standard   | `10.5281/zenodo.1460976`_ |
+--------+--------------------------------------------------------------+----------------------+------------+---------------------------+
+| 7      | `Structure of Top-Level Sub-Packages`_                       | Erik T. Everson,     | standard   |                           |


This is missing its DOI.

This hasn't been uploaded to Zenodo, so it does not yet have a DOI.

I lied. It does have one, which I'll add.

Do ↑

namurphy changed the title ~~Add PLEP 8 on switching to calendar versioning~~ Add PLEP on switching to calendar versioning Nov 22, 2022

namurphy commented Nov 22, 2022

View reviewed changes

PLEP-0008.rst Outdated Show resolved Hide resolved

StanczakDominik reviewed Nov 23, 2022

View reviewed changes

PLEP-0008.rst Outdated Show resolved Hide resolved

StanczakDominik approved these changes Nov 23, 2022

View reviewed changes

StanczakDominik approved these changes Nov 30, 2022

View reviewed changes

namurphy added 6 commits November 30, 2022 14:40

Begin new PLEP on date-based versioning

aea0ce6

Note on PLEP 5 that it's superseded

afacc5e

Add admonition that PLEP 5 has been superseded

7712bf7

Update PLEP 8

174d3f0

Update index of PLEPs

bf23322

Update README.rst

8d7a48d

namurphy force-pushed the amend-plep-5-date-based-versioning branch from 5e21dd4 to 8d7a48d Compare November 30, 2022 19:41

namurphy marked this pull request as ready for review November 30, 2022 19:46

namurphy requested a review from rocco8773 November 30, 2022 19:53

namurphy mentioned this pull request Nov 30, 2022

Automate monthly beta releases PlasmaPy/PlasmaPy#1786

Open

StanczakDominik approved these changes Dec 1, 2022

View reviewed changes

rocco8773 reviewed Dec 8, 2022

View reviewed changes

README.rst Outdated Show resolved Hide resolved

rocco8773 reviewed Dec 8, 2022

View reviewed changes

PLEP-0008.rst Outdated Show resolved Hide resolved

rocco8773 reviewed Dec 8, 2022

View reviewed changes

PLEP-0008.rst Outdated Show resolved Hide resolved

rocco8773 reviewed Dec 8, 2022

View reviewed changes

PLEP-0008.rst Outdated Show resolved Hide resolved

rocco8773 reviewed Dec 8, 2022

View reviewed changes

PLEP-0008.rst Outdated Show resolved Hide resolved

rocco8773 reviewed Dec 8, 2022

View reviewed changes

PLEP-0008.rst Outdated Show resolved Hide resolved

rocco8773 reviewed Dec 8, 2022

View reviewed changes

PLEP-0008.rst Outdated Show resolved Hide resolved

rocco8773 reviewed Dec 8, 2022

View reviewed changes

namurphy commented Dec 8, 2022

View reviewed changes

PLEP-0008.rst Outdated Show resolved Hide resolved

Remove point about switch being permanent

c43644b

rocco8773 reviewed Dec 8, 2022

View reviewed changes

namurphy and others added 2 commits December 8, 2022 16:04

Apply suggestions from code review

fcc085d

Co-authored-by: Erik Everson <[email protected]>

Apply suggestions from code review

a1301e3

Co-authored-by: Erik Everson <[email protected]>

Remove statement about zero-padded month

0778dd0

Co-authored-by: Erik Everson <[email protected]>

StanczakDominik reviewed Dec 12, 2022

View reviewed changes

PLEP-0008.rst Outdated Show resolved Hide resolved

StanczakDominik approved these changes Dec 12, 2022

View reviewed changes

namurphy and others added 6 commits December 12, 2022 19:49

Add missing word

c5f0393

Co-authored-by: Dominik Stańczak-Marikin <[email protected]>

Add DOI to PLEP 8

5b619dc

Update index of PLEPs

5ea2042

Update PLEP 8 and author list

ed2d29c

Update PLEP 8

c0a718b

Minor updates to PLEP 8

02ed984

namurphy requested a review from rocco8773 December 14, 2022 21:50

namurphy commented Jan 10, 2023

View reviewed changes

PLEP-0005.rst Outdated Show resolved Hide resolved

Remove admonition

fe0a4c1

namurphy commented Jan 10, 2023

View reviewed changes

rocco8773 reviewed Jan 10, 2023

View reviewed changes

rocco8773 approved these changes Jan 10, 2023

View reviewed changes

namurphy added 7 commits January 11, 2023 14:40

Remove admonition

45db589

Add link to DOI for PLEP 8

bd92986

Update PLEP 5

26a6916

Update PLEP authorship

532b2a1

Update date

4ac2801

Update DOI

3dbe966

Update formatting

525dcc8

namurphy changed the title ~~Add PLEP on switching to calendar versioning~~ Add PLEP 8 on switching to calendar versioning Jan 11, 2023

namurphy merged commit 0f4080a into PlasmaPy:main Jan 11, 2023

namurphy deleted the amend-plep-5-date-based-versioning branch January 11, 2023 22:08

	.. \|PLEP 8\| replace:: https://github.com/PlasmaPy/PlasmaPy-PLEPs/blob/main/PLEP-0007.rst
	.. \|PLEP 8\| replace:: https://github.com/PlasmaPy/PlasmaPy-PLEPs/blob/main/PLEP-0008.rst

		.. note::

		This PLEP supersedes \|PLEP 5\|, which is no longer in effect.

Add PLEP 8 on switching to calendar versioning #39

Add PLEP 8 on switching to calendar versioning #39

Uh oh!

Conversation

namurphy commented Nov 22, 2022

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

rocco8773 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

StanczakDominik commented Dec 12, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

namurphy commented Dec 14, 2022

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rocco8773 Jan 10, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

StanczakDominik commented Dec 12, 2022 •

edited

Loading

rocco8773 Jan 10, 2023 •

edited

Loading