From cef8f72e6436fd2b3f37e723f38e2d009e3c9c73 Mon Sep 17 00:00:00 2001 From: gabalafou Date: Tue, 26 Nov 2024 12:18:37 -0600 Subject: [PATCH] Publish version specification --- .github/ISSUE_TEMPLATE/release.md | 2 +- README.md | 5 +++++ RELEASE.md | 4 ++-- 3 files changed, 8 insertions(+), 3 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/release.md b/.github/ISSUE_TEMPLATE/release.md index be98ad0c..ffcc0f62 100644 --- a/.github/ISSUE_TEMPLATE/release.md +++ b/.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](https://conda.store/community/maintenance/release/#calver-details) - [ ] 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 diff --git a/README.md b/README.md index eb9e4138..e1cd1040 100644 --- a/README.md +++ b/README.md @@ -110,3 +110,8 @@ 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 + +We follow a [style of CalVer](https://conda.store/community/maintenance/release/#calver-details). diff --git a/RELEASE.md b/RELEASE.md index 2c830fdb..bda6ff0a 100644 --- a/RELEASE.md +++ b/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](https://conda.store/community/maintenance/release/#calver-details) 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.