Publish version specification

.github/ISSUE_TEMPLATE/release.md

@@ -24,7 +24,7 @@ Release captain responsible - <@gh_username>
 
 - [ ] Create a new git branch for the release `git checkout -b release-2024.9.1`
   - [ ] Prepare the branch just in case `git clean -fxdq`
-- [ ] Bump `conda-store-ui` version in `package.json`
+- [ ] Bump `conda-store-ui` version in `package.json` following our [version specification](../../README.md#version-specification)
 - [ ] Follow the manual release instructions in the `Release.md` file (do not make the release yet!)
 - [ ] Make a release commit: `git commit -m 'REL - 2024.9.1'`
 - [ ] Push the release (REL) commit

README.md

@@ -110,3 +110,26 @@ conda-store-ui is developed under the [BSD-3 LICENSE](./LICENSE).
 [conda-store-ui-docs]: https://conda-incubator.github.io/conda-store-ui/?path=/docs/welcome--docs
 [conda-store-repo]: https://github.com/conda-incubator/conda-store
 [jupyterlab-conda-store-repo]: https://github.com/conda-incubator/jupyterlab-conda-store
+
+
+## Version specification
+
+Format: `YYYY.MM.MICRO` or `YYYY.MM.MICRO-MOD`
+
+- `YYYY` year that this version was released, four digits
+- `MM` month that this version was released, one of [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12]
+- `MICRO` an integer in [1, 2, 3, ...], counting the number of releases over the month
+- `MOD` optional modifier, such as `dev`, `rc1`, `alpha`, `beta`, etc.
+
+Valid examples:
+
+- 2030.1.1-dev
+- 2030.12.40
+- 2020.8.9
+
+Invalid examples:
+
+- 30.1.1 (year must be four digits)
+- 2030.01.1 (month must not be zero-padded)
+- 2030.11.01 (`MICRO` should not be zero-padded)
+- 2030.1-dev (missing `MICRO`)

RELEASE.md

@@ -3,7 +3,7 @@
 1. Open a new release issue in the repository, following the [release issue template](../.github/ISSUE_TEMPLATE/release.md).
 1. Create a new branch for the release `git checkout -b release-2024.9.1`
 1. Clean the branch `git clean -fxdq`
-1. Increment the version in `package.json`
+1. Increment the version in `package.json` following our [version specification](./README.md#version-specification)
 1. Build the package locally:
 
    ```bash
@@ -22,7 +22,7 @@
 
    ```
 
-> [!IMPORTANT]  
+> [!IMPORTANT]
 > You need to be logged in to the `npmjs` registry to publish the package.
 > And have access to the `conda-store` npm namespace.