Skip to content

Commit

Permalink
JS: Guidelines for tags to use (Azure#855)
Browse files Browse the repository at this point in the history
* 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 <xirzec@xirzec.com>

* Update docs/policies/releases.md

Co-Authored-By: Jeff Fisher <xirzec@xirzec.com>

* hot fix -> hotfix

Co-Authored-By: Jeff Fisher <xirzec@xirzec.com>
  • Loading branch information
2 people authored and adrianhall committed Dec 6, 2019
1 parent cfe83d6 commit e7f28b3
Showing 1 changed file with 12 additions and 9 deletions.
21 changes: 12 additions & 9 deletions docs/policies/releases.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down

0 comments on commit e7f28b3

Please sign in to comment.