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

What is the Current branch considered? #10718

Closed
pertrai1 opened this issue Jan 10, 2017 · 10 comments
Closed

What is the Current branch considered? #10718

pertrai1 opened this issue Jan 10, 2017 · 10 comments
Labels
doc Issues and PRs related to the documentations. meta Issues and PRs related to the general management of the project. question Issues that look for answers.

Comments

@pertrai1
Copy link

  • Version:
  • Platform:
  • Subsystem:

This is a question in regards to understanding the README.md file. It states:

Nightly: Versions of code in this repository on the current Current branch, automatically built every 24-hours where changes exist. Use with caution.

What exactly is the "Current" branch? That does not make it clear to me what branch this is. Don't know if this is me being new, but thought that this is not easy to decipher.

@addaleax
Copy link
Member

What exactly is the "Current" branch?

That would be v7.x (see the definitions for “Current” in the README / https://github.com/nodejs/LTS); but:

Nightly: Versions of code in this repository on the current Current branch, automatically built every 24-hours where changes exist.

I think that’s not true, the SHAs for the nightlies seem to be master SHAs.

@addaleax addaleax added doc Issues and PRs related to the documentations. meta Issues and PRs related to the general management of the project. labels Jan 10, 2017
@mscdex mscdex added the question Issues that look for answers. label Jan 10, 2017
@Fishrock123
Copy link
Contributor

I don't think we ever got around to Current branch nightlies. They have only ever been off master.

@evanlucas
Copy link
Contributor

It seems we do for some of them.

https://nodejs.org/download/nightly/

There is a nightly for v6.x, v7.x, and master

@sam-github
Copy link
Contributor

sam-github commented Jan 10, 2017

This issue is the inverse of nodejs/Release#174

I think its worth considering incorporating https://github.com/nodejs/LTS/blob/master/README.md into https://github.com/nodejs/node/blob/master/README.md, the distinction between the two is arbitrary from a user of node's perspective, it came about historically because the LTS WG did the work of considering and designing the LTS process, and documented the result in their README. The history is past, the practice they developed is well established, time to move the docs.

The README for the LTS repo can then be rewritten to just have information about the working group organization, its members, policies, etc., instead of information important to users of node.

/cc @williamkapke who recently requested that all WGs have some common features in their READMEs (such as members).

/cc @gibfahn and @Fishrock123 who were wrestling with trying keep the Current docs in nodejs/node, the LTS docs in nodejs/LTS, despite that the two are only understandable as a conceptual pair.

@Trott
Copy link
Member

Trott commented Jul 15, 2017

This issue has been inactive for sufficiently long that it seems like perhaps it should be closed. Feel free to re-open (or leave a comment requesting that it be re-opened) if you disagree. I'm just tidying up and not acting on a super-strong opinion or anything like that.

@Trott Trott closed this as completed Jul 15, 2017
@gibfahn gibfahn reopened this Jul 16, 2017
@gibfahn
Copy link
Member

gibfahn commented Jul 16, 2017

I think the minimum this needs is a sentence in https://github.com/nodejs/node#current-and-lts-releases saying "for more info about Current and LTS release, see the LTS Readme"

@gibfahn
Copy link
Member

gibfahn commented Jul 16, 2017

Actually this is totally documented above. @pertrai1 does this paragraph not adequately explain what current means? If not what would you like to see?

Current: Released from active development branches of this repository, versioned by SemVer and signed by a member of the Release Team. Code for Current releases is organized in this repository by major version number. For example: v4.x. The major version number of Current releases will increment every 6 months allowing for breaking changes to be introduced. This happens in April and October every year. Current release lines beginning in October each year have a maximum support life of 8 months. Current release lines beginning in April each year will convert to LTS (see below) after 6 months and receive further support for 30 months.

@pertrai1
Copy link
Author

@gibfahn - your minimum sentence that you mention above where the user has a reference link to follow - "LTS Readme" - I think that would be helpful in this situation.

@gibfahn
Copy link
Member

gibfahn commented Jul 17, 2017

@pertrai1 makes sense, let me know if you think #14259 would make things clearer.

I totally didn't see any of this documentation btw, and I've looked at the README a bunch of times. So any feedback we can get on increasing clarity is very helpful.

@pertrai1
Copy link
Author

👍 thank you @gibfahn

addaleax pushed a commit that referenced this issue Jul 18, 2017
PR-URL: #14259
Fixes: #10718
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Timothy Gu <timothygu99@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Fishrock123 pushed a commit that referenced this issue Jul 19, 2017
PR-URL: #14259
Fixes: #10718
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Timothy Gu <timothygu99@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
MylesBorins pushed a commit that referenced this issue Aug 16, 2017
PR-URL: #14259
Fixes: #10718
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Timothy Gu <timothygu99@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
MylesBorins pushed a commit that referenced this issue Aug 16, 2017
PR-URL: #14259
Fixes: #10718
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Timothy Gu <timothygu99@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
MylesBorins pushed a commit that referenced this issue Sep 5, 2017
PR-URL: #14259
Fixes: #10718
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Timothy Gu <timothygu99@gmail.com>
Reviewed-By: James M Snell <jasnell@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. meta Issues and PRs related to the general management of the project. question Issues that look for answers.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

8 participants