Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: update process.release #35167

Merged
merged 1 commit into from
Sep 14, 2020
Merged

doc: update process.release #35167

merged 1 commit into from
Sep 14, 2020

Conversation

schamberg97
Copy link
Contributor

@schamberg97 schamberg97 commented Sep 12, 2020

Process.release doc is severely outdated. This PR includes info about LTS releases 10 and 12.

Checklist

@nodejs-github-bot nodejs-github-bot added doc Issues and PRs related to the documentations. process Issues and PRs related to the process subsystem. labels Sep 12, 2020
@@ -1773,18 +1773,17 @@ tarball.
* `lts` {string} a string label identifying the [LTS][] label for this release.
This property only exists for LTS releases and is `undefined` for all other
release types, including _Current_ releases. Currently the valid values are:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we're not going to maintain a list of all possible values, then I think we should change the preceding wording here from "Currently the valid values are:" to something like "Valid values may include:" to indicate that the following list is a subset. While "Argon" and others may no longer be supported they are still technically LTS release lines that someone could encounter.

Copy link
Contributor Author

@schamberg97 schamberg97 Sep 12, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about "Valid values include the LTS Release Codenames (including those that are no longer supported). A non-exhaustive example of these codenames includes:" ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps the links to Release schedule and Changelogs on Github should also be included?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@schamberg97 That sounds good, feel free to add those 🙂

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll do it, but I am away from computer until midgnight

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We currently have a waiting period of 48 hours before we merge any non-trivial PR anyway, so take your time :)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry for the delay, had problems with my personal OSS project that was a bigger priority for me. This should probably be reviewed again, just in case

doc/api/process.md Outdated Show resolved Hide resolved
Copy link
Member

@Trott Trott left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me, with or without the one suggestion I made.

@Trott Trott merged commit 571dff8 into nodejs:master Sep 14, 2020
@Trott
Copy link
Member

Trott commented Sep 14, 2020

Landed in 571dff8

@Trott
Copy link
Member

Trott commented Sep 14, 2020

Thanks for the contribution! 🎉

`process.release` documentation is out of date. This commit makes it up
to date.

PR-URL: #35167
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Rich Trott <rtrott@gmail.com>
ruyadorno pushed a commit that referenced this pull request Sep 17, 2020
`process.release` documentation is out of date. This commit makes it up
to date.

PR-URL: #35167
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Rich Trott <rtrott@gmail.com>
@ruyadorno ruyadorno mentioned this pull request Sep 21, 2020
4 tasks
addaleax pushed a commit that referenced this pull request Sep 22, 2020
`process.release` documentation is out of date. This commit makes it up
to date.

PR-URL: #35167
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Rich Trott <rtrott@gmail.com>
@codebytere codebytere mentioned this pull request Sep 28, 2020
joesepi pushed a commit to joesepi/node that referenced this pull request Jan 8, 2021
`process.release` documentation is out of date. This commit makes it up
to date.

PR-URL: nodejs#35167
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Issues and PRs related to the documentations. process Issues and PRs related to the process subsystem.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants