Skip to content

chore(README): update notes regarding releases #936

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 2, 2019
Merged

chore(README): update notes regarding releases #936

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
765f788
chore(README): update notes regarding releases
JamesHenry Sep 2, 2019
dfb1dd4
chore(README): update notes on releases
JamesHenry Sep 2, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -187,16 +187,20 @@ If you are interested in using TypeScript and ESLint together, you will want to

All of the packages are published with the same version number to make it easier to coordinate both releases and installations.

Additionally, we also publish a canary release on every successful merge to master, so you never need to wait for a new stable version to make use of any updates.
We publish a canary release on every successful merge to master, so **you never need to wait for a new stable version to make use of any updates**.

The `latest` (stable) version is:
Additionally, we promote the to the `latest` tag on NPM once per week, **on Mondays at 1pm Eastern**.

The latest version under the `latest` tag is:

<a href="https://www.npmjs.com/package/@typescript-eslint/parser"><img src="https://img.shields.io/npm/v/@typescript-eslint/parser/latest.svg?style=flat-square" alt="NPM Version" /></a>

The `canary` (latest master) version is:
The latest version under the `canary` tag **(latest commit to master)** is:

<a href="https://www.npmjs.com/package/@typescript-eslint/parser"><img src="https://img.shields.io/npm/v/@typescript-eslint/parser/canary.svg?style=flat-square" alt="NPM Version" /></a>

(Note: The only exceptions to the automated publishes described above are when we are in the final phases of creating the next major version of the libraries - e.g. going from 1.x.x to 2.x.x. During these periods, we manually publish `canary` releases until we are happy with the release and promote it to `latest`.)

<br>

## Supported TypeScript Version
Expand Down