Skip to content

Commit 7f95ffe

Browse files
authored
docs: document version support goals (#315)
1 parent 3daa994 commit 7f95ffe

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

packages/google-cloud-oslogin/README.md

+21
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,27 @@ has instructions for running the samples.
8686
The [Google Cloud OS Login Node.js Client API Reference][client-docs] documentation
8787
also contains samples.
8888

89+
## Supported Node.js Versions
90+
91+
Our client libraries follow the [Node.js release schedule](https://nodejs.org/en/about/releases/).
92+
Libraries are compatible with all current _active_ and _maintenance_ versions of
93+
Node.js.
94+
95+
Client libraries targetting some end-of-life versions of Node.js are available, and
96+
can be installed via npm [dist-tags](https://docs.npmjs.com/cli/dist-tag).
97+
The dist-tags follow the naming convention `legacy-(version)`.
98+
99+
_Legacy Node.js versions are supported as a best effort:_
100+
101+
* Legacy versions will not be tested in continuous integration.
102+
* Some security patches may not be able to be backported.
103+
* Dependencies will not be kept up-to-date, and features will not be backported.
104+
105+
#### Legacy tags available
106+
107+
* `legacy-8`: install client libraries from this dist-tag for versions
108+
compatible with Node.js 8.
109+
89110
## Versioning
90111

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

0 commit comments

Comments
 (0)