From efb2aaf3eb60df6cbab0c3ddd0ed154f05dd14be Mon Sep 17 00:00:00 2001 From: Filip Maj Date: Mon, 3 Jun 2024 16:37:09 -0400 Subject: [PATCH] docs: the cli test package version should include a build metadata and not a pre-release suffix. --- .github/maintainers_guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/maintainers_guide.md b/.github/maintainers_guide.md index 720282365..3c4bd8193 100644 --- a/.github/maintainers_guide.md +++ b/.github/maintainers_guide.md @@ -165,7 +165,7 @@ Releasing can feel intimidating at first, but rest assured: if you make a mistak ### 🔖 Versioning and Tags This project is versioned using [Semantic Versioning](http://semver.org/), particularly in the [npm flavor](https://docs.npmjs.com/getting-started/semantic-versioning). Each release is tagged using git. The naming convention for tags is `{package_name}@{version}`. For example, the tag `@slack/web-api@v5.0.0` marks the v5.0.0 release of the `@slack/web-api` package. A single commit will have multiple tags when multiple packages are released simultaneously. -One package that expands upon the standard major.minor.patch version schema typically associated with Semantic Versioning is the `@slack/cli-test` package. This package employs standard major.minor.patch version, in addition to a [pre-release suffix](https://semver.org/#spec-item-9) suffix of the form `-cli.X.Y.Z`, e.g. `0.1.0-cli.2.24.0`. The version after `-cli.` communicates compatibility between the `@slack/cli-test` package and the [Slack Platfrom CLI](https://api.slack.com/automation/quickstart) itself. +One package that expands upon the standard major.minor.patch version schema typically associated with Semantic Versioning is the `@slack/cli-test` package. This package employs standard major.minor.patch version, in addition to a [build metadata suffix](https://semver.org/#spec-item-10) suffix of the form `+cli.X.Y.Z`, e.g. `0.1.0+cli.2.24.0`. The version after `+cli.` communicates compatibility between the `@slack/cli-test` package and the [Slack Platfrom CLI](https://api.slack.com/automation/quickstart) itself. ### 🪵 Branches `main` is where active development occurs. Long running named feature branches are occasionally created for collaboration on a feature that has a large scope (because everyone cannot push commits to another person's open Pull Request). After a major version increment, a maintenance branch for the older major version is left open (e.g. `v3`, `v4`, etc).