Skip to content

Commit a1af6c3

Browse files
authored
Add the version support policy (#4390)
As discussed at the GraphQL working group (via graphql/graphql-wg#1614 and at various meetings) and as agreed in last weeks meeting, the GraphQL.JS version policy as drafted by @JoviDeCroock has been approved and aligns with the informal policy we already had in place. As such, I have added it to the README. This PR also promotes a few headings (H3 -> H2) to make more structural sense in the TOC.
1 parent 5463bc1 commit a1af6c3

File tree

1 file changed

+48
-5
lines changed

1 file changed

+48
-5
lines changed

README.md

+48-5
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ graphql({ schema, source }).then((result) => {
105105

106106
**Note**: Please don't forget to set `NODE_ENV=production` if you are running a production server. It will disable some checks that can be useful during development but will significantly improve performance.
107107

108-
### Want to ride the bleeding edge?
108+
## Want to ride the bleeding edge?
109109

110110
The `npm` branch in this repository is automatically maintained to be the last
111111
commit to `main` to pass all tests, in the same form found on npm. It is
@@ -127,7 +127,7 @@ Each release of GraphQL.js will be accompanied by an experimental release contai
127127

128128
Community feedback on this experimental release is much appreciated and can be provided on the [issue created for this purpose](https://github.com/graphql/graphql-js/issues/2848).
129129

130-
### Using in a Browser
130+
## Using in a Browser
131131

132132
GraphQL.js is a general-purpose library and can be used both in a Node server
133133
and in the browser. As an example, the [GraphiQL](https://github.com/graphql/graphiql/)
@@ -139,7 +139,7 @@ the portions of the library you use. This works because GraphQL.js is distribute
139139
with both CommonJS (`require()`) and ESModule (`import`) files. Ensure that any
140140
custom build configurations look for `.mjs` files!
141141

142-
### Contributing
142+
## Contributing
143143

144144
We actively welcome pull requests. Learn how to [contribute](./.github/CONTRIBUTING.md).
145145

@@ -151,10 +151,53 @@ You can find [detailed information here](https://github.com/graphql/graphql-wg/t
151151

152152
If your company benefits from GraphQL and you would like to provide essential financial support for the systems and people that power our community, please also consider membership in the [GraphQL Foundation](https://foundation.graphql.org/join).
153153

154-
### Changelog
154+
## Changelog
155155

156156
Changes are tracked as [GitHub releases](https://github.com/graphql/graphql-js/releases).
157157

158-
### License
158+
## License
159159

160160
GraphQL.js is [MIT-licensed](./LICENSE).
161+
162+
## Version Support
163+
164+
GraphQL.JS follows Semantic Versioning (SemVer) for its releases. Our version support policy is as follows:
165+
166+
- Latest Major Version: We provide full support, including bug fixes and security updates, for the latest major version of GraphQL.JS.
167+
- Previous Major Version: We offer feature support for the previous major version for 12 months after the release of the newest major version.
168+
This means that for 12 months we can backport features for specification changes _if_ they don't cause any breaking changes. We'll continue
169+
supporting the previous major version with bug and security fixes.
170+
- Older Versions: Versions older than the previous major release are considered unsupported. While the code remains available,
171+
we do not actively maintain or provide updates for these versions.
172+
One exception to this rule is when the older version has been released < 1 year ago, in that case we
173+
will treat it like the "Previous Major Version".
174+
175+
### Long-Term Support (LTS)
176+
177+
We do not currently offer a Long-Term Support version of GraphQL.JS. Users are encouraged to upgrade to the latest stable version
178+
to receive the most up-to-date features, performance improvements, and security updates.
179+
180+
### End-of-Life (EOL) Schedule
181+
182+
We will announce the EOL date for a major version at least 6 months in advance.
183+
After a version reaches its EOL, it will no longer receive updates, even for critical security issues.
184+
185+
### Upgrade Assistance
186+
187+
To assist users in upgrading to newer versions:
188+
189+
- We maintain detailed release notes for each version, highlighting new features, breaking changes, and deprecations.
190+
- [Our documentation](https://www.graphql-js.org/) includes migration guides for moving between major versions.
191+
- The [community forum (Discord channel #graphql-js)](https://discord.graphql.org) is available for users who need additional assistance with upgrades.
192+
193+
### Security Updates
194+
195+
We prioritize the security of GraphQL.JS:
196+
197+
- Critical security updates will be applied to both the current and previous major version.
198+
- For versions that have reached EOL, we strongly recommend upgrading to a supported version to receive security updates.
199+
200+
### Community Contributions
201+
202+
We welcome community contributions for all versions of GraphQL.JS. However, our maintainers will primarily focus on reviewing
203+
and merging contributions for supported versions.

0 commit comments

Comments
 (0)