Skip to content

Commit 93c4522

Browse files
authored
Documentation: Update versioning.md
1 parent 056e9aa commit 93c4522

File tree

1 file changed

+6
-8
lines changed

1 file changed

+6
-8
lines changed

docs/development/versioning.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,15 @@
11
# SPM version numbers
2-
SPM has a **version** and a **release**. At the time of writing, the version is **SPM12** and the release is **dev**.
2+
SPM has a **version** and a **release**. For example, the version may be **SPM25** and the release may be **25.01**.
33

44
Other toolboxes that depend on SPM use this information to check whether a compatible SPM version is installed. A common pattern is to split the version string into two parts, e.g. SPM12 becomes **SPM** and **12**, and then the latter part is compared to the desired version number.
55

6-
## Transition to calendar versioning
7-
SPM is moving towards [calendar versioning](https://calver.org/).
6+
## Calendar versioning
7+
With the introduction of SPM25, SPM moved to [calendar versioning](https://calver.org/). The format is **YY.0M[.MICRO]**, where YY is the short year (e.g. 25 for the year 2025), 0M is the zero padded month (e.g. 06 for June or 12 for December) and .MICRO is an optional integer for patches.
88

9-
The proposed new format is **YY.0M[.MICRO]**, where YY is the short year (e.g. 24 for the year 2024), 0M is the zero padded month (e.g. 06 for June or 12 for December) and .MICRO is an optional integer for patches.
9+
For backward compatibility, the version and release are set as follows:
1010

11-
For backward compatibility, the proposal is to set the version and release as follows:
12-
13-
- **Version**: SPMYY, where YY is the year of the most recent release, e.g. SPM24
14-
- **Release**: either 00.00 for the development version on Github or for a release: YY.0M[.MICRO], e.g. 24.07 for July 2024
11+
- **Version**: SPMYY, where YY is the year of the most recent release, e.g. SPM25
12+
- **Release**: either 00.00 for the development version on Github or for a release: YY.0M[.MICRO], e.g. 25.07 for July 2025
1513

1614
## Where the SPM version number is stored
1715
The SPM version is stored on the second line of the file Contents.m in the root directory, or Contents.txt when SPM is in deployed mode (i.e., compiled).

0 commit comments

Comments
 (0)