From e7f28b3a765ba9c4c95441ebcb4277131514436b Mon Sep 17 00:00:00 2001 From: Ramya Rao Date: Fri, 6 Dec 2019 15:35:30 -0800 Subject: [PATCH] JS: Guidelines for tags to use (#855) * JS: Guidelines for tags to use * JS: Guidelines for tags to use * tags and hotfixes * Update text on preview packages Co-Authored-By: Jeff Fisher * Update docs/policies/releases.md Co-Authored-By: Jeff Fisher * hot fix -> hotfix Co-Authored-By: Jeff Fisher --- docs/policies/releases.md | 21 ++++++++++++--------- 1 file changed, 12 insertions(+), 9 deletions(-) diff --git a/docs/policies/releases.md b/docs/policies/releases.md index e1b1616a8bd..dcc484501b7 100644 --- a/docs/policies/releases.md +++ b/docs/policies/releases.md @@ -143,16 +143,19 @@ In rare cases where a customer cannot take all the latest patch versions with al #### JavaScript -The JavaScript community generally follows [SemVer](https://semver.org/). For preview releases, we will release with an [npm distribution tag](https://docs.npmjs.com/cli/dist-tag) in the formats: +The JavaScript community generally follows [SemVer](https://semver.org/). +When publishing an npm package, [npm distribution tags](https://docs.npmjs.com/cli/dist-tag) can be specified. +If none is provided, the `latest` tag gets used by default by the `npm publish` command. + +Below are the guidelines for versions and tags to use: +- GA releases will follow [SemVer](https://semver.org/) and the published package should have the tag `latest`. + - If a hotfix is being shipped for a version older than the current GA version, then ensure that the hotfix gets no tags. + One way to do this is to use a dummy tag when publishing and deleting the tag afterwards. + - If a package has moved from preview to GA, ensure that the `next` tag is deleted. +- Preview releases will use the format `X.Y.Z-preview.N` for version and the published package should have the tag `next`. + - Additionally, use the `@latest` tag **only** if the package has never had a GA release. +- Daily releases will use the format `X.Y.Z-dev.YYYYMMDD.r` (`r` is based on the number of builds performed on the given day) and the published package will have the tag `dev`. -- `X.Y.Z-dev.YYYYMMDD.r` (`r` is based on the number of builds performed on the given day) -- `X.Y.Z-preview.N` - -JavaScript dev and preview releases are published to npm with the `@dev` or `@next` tags. Use the following: - -```bash -$ npm install @azure/package@next -``` ##### Incrementing after release (JS)