Skip to content

Commit

Permalink
docs: document the release schedule we follow (#454)
Browse files Browse the repository at this point in the history
  • Loading branch information
bcoe authored Mar 24, 2020
1 parent 7e98e16 commit 6a17abc
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions synthtool/gcp/templates/node_library/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,27 @@ has instructions for running the samples.
The [{{ metadata['repo']['name_pretty'] }} {{ metadata['repo']['language']|language_pretty }} Client API Reference][client-docs] documentation
also contains samples.
{% endif %}
## Supported Node.js Versions

Our client libraries follow the [Node.js release schedule](https://nodejs.org/en/about/releases/).
Libraries are compatible with all current _active_ and _maintenance_ versions of
Node.js.

Client libraries targetting some end-of-life versions of Node.js are available, and
can be installed via npm [dist-tags](https://docs.npmjs.com/cli/dist-tag).
The dist-tags follow the naming convention `legacy-(version)`.

_Legacy Node.js versions are supported as a best effort:_

* Legacy versions will not be tested in continuous integration.
* Some security patches may not be able to be backported.
* Dependencies will not be kept up-to-date, and features will not be backported.

#### Legacy tags available

* `legacy-8`: install client libraries from this dist-tag for versions
compatible with Node.js 8.

## Versioning

This library follows [Semantic Versioning](http://semver.org/).
Expand Down

0 comments on commit 6a17abc

Please sign in to comment.