Skip to content

Commit 6a17abc

Browse files
author
Benjamin E. Coe
authored
docs: document the release schedule we follow (#454)
1 parent 7e98e16 commit 6a17abc

1 file changed

Lines changed: 21 additions & 0 deletions

File tree

  • synthtool/gcp/templates/node_library

synthtool/gcp/templates/node_library/README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,27 @@ has instructions for running the samples.
8484
The [{{ metadata['repo']['name_pretty'] }} {{ metadata['repo']['language']|language_pretty }} Client API Reference][client-docs] documentation
8585
also contains samples.
8686
{% endif %}
87+
## Supported Node.js Versions
88+
89+
Our client libraries follow the [Node.js release schedule](https://nodejs.org/en/about/releases/).
90+
Libraries are compatible with all current _active_ and _maintenance_ versions of
91+
Node.js.
92+
93+
Client libraries targetting some end-of-life versions of Node.js are available, and
94+
can be installed via npm [dist-tags](https://docs.npmjs.com/cli/dist-tag).
95+
The dist-tags follow the naming convention `legacy-(version)`.
96+
97+
_Legacy Node.js versions are supported as a best effort:_
98+
99+
* Legacy versions will not be tested in continuous integration.
100+
* Some security patches may not be able to be backported.
101+
* Dependencies will not be kept up-to-date, and features will not be backported.
102+
103+
#### Legacy tags available
104+
105+
* `legacy-8`: install client libraries from this dist-tag for versions
106+
compatible with Node.js 8.
107+
87108
## Versioning
88109

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

0 commit comments

Comments
 (0)