You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 22c9073
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: APE21.rst
+12-10Lines changed: 12 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ author: Thomas Robitaille, Pey Lian Lim, Simon Conseil
5
5
6
6
date-created: 2023 February 16
7
7
8
-
date-last-revised: 2023 February 20 <keep this up to date anytime something changes>
8
+
date-last-revised: 2023 February 21 <keep this up to date anytime something changes>
9
9
10
10
date-accepted: <replace with accepted date>
11
11
@@ -18,7 +18,7 @@ Abstract
18
18
--------
19
19
20
20
This APE proposes to no longer designate any releases of the core package as being
21
-
'longterm support' (LTS) and provide guidance on how to handle API changes and deprecations.
21
+
"long-term support" (LTS) and provide guidance on how to handle API changes and deprecations.
22
22
23
23
24
24
Detailed description
@@ -27,15 +27,15 @@ Detailed description
27
27
`APE 2: Astropy Release Cycle and Version Numbering <https://doi.org/10.5281/zenodo.1043887>`_ describes the release cycle
28
28
for the core astropy package, which consists of major releases every 6 months that
29
29
add new features (e.g., v5.2), and releases in between this that are limited to fixing bugs
30
-
or updating documentation (e.g., v5.2.1). Every two years, major releases are designated
30
+
or updating documentation (e.g., v5.2.1). Every 2 years, major releases are designated
31
31
as being LTS (e.g., v5.0) and we have committed to releasing bugfix releases
32
-
for this version (e.g., v5.0.3) for up to two years.
32
+
for this version (e.g., v5.0.3) for up to 2 years.
33
33
34
34
At the start of the project, having LTS releases was critical for acceptance by
35
35
large organizations/projects for which stability is paramount, as the core package went through
36
36
significant API changes from version to version due to the youth of the project and LTS
37
37
releases were a way to shield against these changes, or at least reduce disruption to
38
-
be every two years.
38
+
be every 2 years.
39
39
40
40
LTS releases are however not free:
41
41
@@ -58,10 +58,10 @@ in astropy either.
58
58
This APE proposes the following:
59
59
60
60
* No longer designate any releases as LTS.
61
-
* Keep the 6-month release cycle and bump releases to x.0 every two years.
62
-
* Refer to the x.0 releases every two years (e.g., v6.0) as 'major'
63
-
releases, other releases every 6 months (e.g., v6.1) as 'minor', and bug fixing
64
-
releases (e.g., v6.1.2) as 'bugfix releases'.
61
+
* Keep the 6-month release cycle and bump releases to x.0 every 2 years.
62
+
* Refer to the x.0 releases every 2 years (e.g., v6.0) as "major"
63
+
releases, other releases every 6 months (e.g., v6.1) as "minor", and bug fixing
64
+
releases (e.g., v6.1.2) as "bugfix" releases.
65
65
* Minimize as much as possible any changes that break API or change results in
66
66
minor releases, but being pragmatic and accepting such changes if they would
67
67
not affect many users.
@@ -71,7 +71,7 @@ This APE proposes the following:
71
71
are deemed to be high impact enough to wait longer).
72
72
73
73
With this in place, we would effectively be striving to maximize stability over
74
-
twoyear periods but users would see deprecation warnings to prepare them for
74
+
two-year periods but users would see deprecation warnings to prepare them for
75
75
changes. This is in contrast to the current LTS system where users might not see
76
76
a deprecation warning until the next LTS release as deprecations are not typically
77
77
backported.
@@ -91,9 +91,11 @@ Backward compatibility
91
91
----------------------
92
92
93
93
N/A
94
+
94
95
Alternatives
95
96
------------
96
97
98
+
<Remove placeholder below before merge>
97
99
If there were any alternative solutions to solving the same problem, they should
98
100
be discussed here, along with a justification for the chosen approach.
0 commit comments