Skip to content

Commit 35cd691

Browse files
authored
docs: add LTS explanation and open vulnerabilities to README (#8077)
1 parent 7844442 commit 35cd691

File tree

2 files changed

+24
-29
lines changed

2 files changed

+24
-29
lines changed

CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -396,7 +396,7 @@ If the commit reverts a previous commit, use the prefix `revert:`, followed by t
396396
397397
### Major Release / Long-Term-Support
398398
399-
Long-Term-Support (LTS) is provided for the previous Parse Server major version. For example, Parse Server 4.x will receive security updates until Parse Server 5.x is superseded by Parse Server 6.x and becomes the new LTS version. While the current major version is published on branch `release`, a LTS version is published on branch `release-#.x.x`, for example `release-4.x.x` for the Parse Server 4.x LTS branch.
399+
While the current major version is published on branch `release`, a Long-Term-Support (LTS) version is published on branch `release-#.x.x`, for example `release-4.x.x` for the Parse Server 4.x LTS branch.
400400
401401
### Preparing Release
402402

README.md

+23-28
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,8 @@ A big *thank you* 🙏 to our [sponsors](#sponsors) and [backers](#backers) who
4242

4343
---
4444

45+
- [Flavors & Branches](#flavors--branches)
46+
- [Long Term Support](#long-term-support)
4547
- [Getting Started](#getting-started)
4648
- [Running Parse Server](#running-parse-server)
4749
- [Compatibility](#compatibility)
@@ -89,13 +91,25 @@ A big *thank you* 🙏 to our [sponsors](#sponsors) and [backers](#backers) who
8991
- [Using automatically generated operations](#using-automatically-generated-operations)
9092
- [Customizing your GraphQL Schema](#customizing-your-graphql-schema)
9193
- [Learning more](#learning-more)
92-
- [Upgrading to 3.0.0](#upgrading-to-300)
93-
- [Want to ride the bleeding edge?](#want-to-ride-the-bleeding-edge)
94+
- [Upgrading to Parse Server 3.0](#upgrading-to-parse-server-30)
9495
- [Contributing](#contributing)
9596
- [Contributors](#contributors)
9697
- [Sponsors](#sponsors)
9798
- [Backers](#backers)
9899

100+
# Flavors & Branches
101+
102+
Parse Server is available in different flavors on different branches:
103+
104+
- The main branches are [release][log_release], [beta][log_beta] and [alpha][log_alpha]. See the [changelog overview](CHANGELOG.md) for details.
105+
- The long-term-support (LTS) branches are named `release-<version>.x.x`, for example `release-4.x.x`. LTS branches do not have pre-release branches.
106+
107+
## Long Term Support
108+
109+
Long-Term-Support (LTS) is provided for the previous Parse Server major version. For example, Parse Server 4.x will receive security updates until Parse Server 5.x is superseded by Parse Server 6.x and becomes the new LTS version. While the current major version is published on branch `release`, a LTS version is published on branch `release-#.x.x`, for example `release-4.x.x` for the Parse Server 4.x LTS branch.
110+
111+
⚠️ LTS versions are provided to help you transition as soon as possible to the current major version. While we aim to fix security vulnerabilities in the LTS version, our main focus is on developing the current major version and preparing the next major release. Therefore we may leave certain vulnerabilities up to the community to fix. Search for [pull requests with the specific LTS base branch](https://github.com/parse-community/parse-server/pulls?q=is%3Aopen+is%3Apr+base%3Arelease-4.x.x) to see the current open vulnerabilities for that LTS branch.
112+
99113
# Getting Started
100114

101115
The fastest and easiest way to get started is to run MongoDB and Parse Server locally.
@@ -1104,37 +1118,15 @@ You also have a very powerful tool inside your GraphQL Playground. Please look a
11041118
11051119
Additionally, the [GraphQL Learn Section](https://graphql.org/learn/) is a very good source to learn more about the power of the GraphQL language.
11061120
1107-
# Upgrading to 3.0.0
1108-
1109-
Starting 3.0.0, parse-server uses the JS SDK version 2.0.
1110-
In short, parse SDK v2.0 removes the backbone style callbacks as well as the Parse.Promise object in favor of native promises.
1111-
All the Cloud Code interfaces also have been updated to reflect those changes, and all backbone style response objects are removed and replaced by Promise style resolution.
1112-
1113-
We have written up a [migration guide](3.0.0.md), hoping this will help you transition to the next major release.
1114-
1115-
# Want to ride the bleeding edge?
1121+
# Upgrading to Parse Server 3.0
11161122
1117-
It is recommend to use builds deployed npm for many reasons, but if you want to use
1118-
the latest not-yet-released version of parse-server, you can do so by depending
1119-
directly on this branch:
1120-
1121-
```
1122-
npm install parse-community/parse-server.git#master
1123-
```
1124-
1125-
## Experimenting <!-- omit in toc -->
1126-
1127-
You can also use your own forks, and work in progress branches by specifying them:
1128-
1129-
```
1130-
npm install github:myUsername/parse-server#my-awesome-feature
1131-
```
1123+
Starting Parse Server 3.0, Parse Server uses the Parse JavaScript SDK 2.0. In short, the Parse JavaScript SDK 2.0 removes the backbone style callbacks as well as the `Parse.Promise` object in favor of native promises. All the Cloud Code interfaces also have been updated to reflect those changes, and all backbone style response objects are removed and replaced by promise style resolution.
11321124
1133-
And don't forget, if you plan to deploy it remotely, you should run `npm install` with the `--save` option.
1125+
We have written up a [migration guide](3.0.0.md) to help you transition to the next major release.
11341126
11351127
# Contributing
11361128
1137-
We really want Parse to be yours, to see it grow and thrive in the open source community. Please see the [Contributing to Parse Server guide](CONTRIBUTING.md).
1129+
Please see the [Contributing Guide](CONTRIBUTING.md).
11381130
11391131
# Contributors
11401132
@@ -1190,3 +1182,6 @@ As of April 5, 2017, Parse, LLC has transferred this code to the parse-community
11901182
[license-svg]: https://img.shields.io/badge/license-BSD-lightgrey.svg
11911183
[license-link]: LICENSE
11921184
[open-collective-link]: https://opencollective.com/parse-server
1185+
[log_release]: https://github.com/parse-community/parse-server/blob/release/changelogs/CHANGELOG_release.md
1186+
[log_beta]: https://github.com/parse-community/parse-server/blob/beta/changelogs/CHANGELOG_beta.md
1187+
[log_alpha]: https://github.com/parse-community/parse-server/blob/alpha/changelogs/CHANGELOG_alpha.md

0 commit comments

Comments
 (0)