From 5788c9822217c5180914d4d7a6650d8412c9a563 Mon Sep 17 00:00:00 2001 From: morrme Date: Wed, 19 Apr 2017 00:51:46 -0500 Subject: [PATCH 1/9] Update COLLABORATOR_GUIDE.md --- COLLABORATOR_GUIDE.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/COLLABORATOR_GUIDE.md b/COLLABORATOR_GUIDE.md index c7939e6eacc840..4b5cbc9cb3c03d 100644 --- a/COLLABORATOR_GUIDE.md +++ b/COLLABORATOR_GUIDE.md @@ -87,6 +87,21 @@ All pull requests that modify executable code should be subjected to continuous integration tests on the [project CI server](https://ci.nodejs.org/). +Here is a summary of current CI jobs: + +[node-test-pull-request] (https://ci.nodejs.org/job/node-test-pull-request/) +`node-test-pull-request` is the standard CI run we do to check Pull Requests. It triggers `node-test-commit`, which runs the `build-ci` and `test-ci` targets on all supported platforms. + +[node-test-linter] (https://ci.nodejs.org/job/node-test-linter/) +The `node-test-linter` only runs the linter targets, which is useful for changes that only affect comments or documentation. + +[citgm-smoker] (https://ci.nodejs.org/view/Node.js-citgm/job/citgm-smoker/) +The `citgm-smoker` job uses CitGM to allow you to run npm install && npm test on a large selection of common modules. This is useful to check whether a change will cause breakage in the ecosystem. To test node ABI changes you can run [citgm-abi-smoker](https://ci.nodejs.org/view/Node.js-citgm/job/citgm-abi-smoker/). + +[node-stress_single-test] (https://ci.nodejs.org/job/node-stress-single-test/) + +[node-test-commit] (https://ci.nodejs.org/job/node-test-commit/) + ### Internal vs. Public API Due to the nature of the JavaScript language, it can often be difficult to From e8897e06eb12fd635bca5476ce1c10172a6e9bdd Mon Sep 17 00:00:00 2001 From: morrme Date: Wed, 19 Apr 2017 00:53:09 -0500 Subject: [PATCH 2/9] Update COLLABORATOR_GUIDE.md --- COLLABORATOR_GUIDE.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/COLLABORATOR_GUIDE.md b/COLLABORATOR_GUIDE.md index 4b5cbc9cb3c03d..7edf403ab62c53 100644 --- a/COLLABORATOR_GUIDE.md +++ b/COLLABORATOR_GUIDE.md @@ -89,18 +89,18 @@ continuous integration tests on the Here is a summary of current CI jobs: -[node-test-pull-request] (https://ci.nodejs.org/job/node-test-pull-request/) +[node-test-pull-request](https://ci.nodejs.org/job/node-test-pull-request/) `node-test-pull-request` is the standard CI run we do to check Pull Requests. It triggers `node-test-commit`, which runs the `build-ci` and `test-ci` targets on all supported platforms. -[node-test-linter] (https://ci.nodejs.org/job/node-test-linter/) +[node-test-linter](https://ci.nodejs.org/job/node-test-linter/) The `node-test-linter` only runs the linter targets, which is useful for changes that only affect comments or documentation. -[citgm-smoker] (https://ci.nodejs.org/view/Node.js-citgm/job/citgm-smoker/) +[citgm-smoker](https://ci.nodejs.org/view/Node.js-citgm/job/citgm-smoker/) The `citgm-smoker` job uses CitGM to allow you to run npm install && npm test on a large selection of common modules. This is useful to check whether a change will cause breakage in the ecosystem. To test node ABI changes you can run [citgm-abi-smoker](https://ci.nodejs.org/view/Node.js-citgm/job/citgm-abi-smoker/). -[node-stress_single-test] (https://ci.nodejs.org/job/node-stress-single-test/) +[node-stress_single-test](https://ci.nodejs.org/job/node-stress-single-test/) -[node-test-commit] (https://ci.nodejs.org/job/node-test-commit/) +[node-test-commit](https://ci.nodejs.org/job/node-test-commit/) ### Internal vs. Public API From bc520c7a6ce7a34b42a3bcd9d4d195394e2fd869 Mon Sep 17 00:00:00 2001 From: morrme Date: Thu, 20 Apr 2017 17:29:15 -0500 Subject: [PATCH 3/9] update job definitions --- COLLABORATOR_GUIDE.md | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/COLLABORATOR_GUIDE.md b/COLLABORATOR_GUIDE.md index 7edf403ab62c53..fe9d8b79820e91 100644 --- a/COLLABORATOR_GUIDE.md +++ b/COLLABORATOR_GUIDE.md @@ -89,18 +89,20 @@ continuous integration tests on the Here is a summary of current CI jobs: -[node-test-pull-request](https://ci.nodejs.org/job/node-test-pull-request/) -`node-test-pull-request` is the standard CI run we do to check Pull Requests. It triggers `node-test-commit`, which runs the `build-ci` and `test-ci` targets on all supported platforms. +* [`node-test-pull-request`](https://ci.nodejs.org/job/node-test-pull-request/) +is the standard CI run we do to check Pull Requests. It triggers `node-test-commit`, which runs the `build-ci` and `test-ci` targets on all supported platforms. -[node-test-linter](https://ci.nodejs.org/job/node-test-linter/) -The `node-test-linter` only runs the linter targets, which is useful for changes that only affect comments or documentation. +* [`node-test-linter`](https://ci.nodejs.org/job/node-test-linter/) +only runs the linter targets, which is useful for changes that only affect comments or documentation. -[citgm-smoker](https://ci.nodejs.org/view/Node.js-citgm/job/citgm-smoker/) -The `citgm-smoker` job uses CitGM to allow you to run npm install && npm test on a large selection of common modules. This is useful to check whether a change will cause breakage in the ecosystem. To test node ABI changes you can run [citgm-abi-smoker](https://ci.nodejs.org/view/Node.js-citgm/job/citgm-abi-smoker/). +* [`citgm-smoker`](https://ci.nodejs.org/view/Node.js-citgm/job/citgm-smoker/) +uses CitGM to allow you to run npm install && npm test on a large selection of common modules. This is useful to check whether a change will cause breakage in the ecosystem. To test node ABI changes you can run [citgm-abi-smoker](https://ci.nodejs.org/view/Node.js-citgm/job/citgm-abi-smoker/). -[node-stress_single-test](https://ci.nodejs.org/job/node-stress-single-test/) +* [`node-stress-single-test`](https://ci.nodejs.org/job/node-stress-single-test/) +is designed to allow one to run a single test over and over on a specific platform to confirm that the test is reliable. -[node-test-commit](https://ci.nodejs.org/job/node-test-commit/) +* [`node-test-commit`](https://ci.nodejs.org/job/node-test-commit/) +runs the `build-ci` and `test-ci` targets on all supported platforms. ### Internal vs. Public API From c94b070369e4fa01d958aae1a592349d268bcb52 Mon Sep 17 00:00:00 2001 From: morrme Date: Fri, 21 Apr 2017 07:15:09 -0500 Subject: [PATCH 4/9] doc: update COLLABORATOR_GUIDE.md Fixes: https://github.com/nodejs/node/issues/12021 --- COLLABORATOR_GUIDE.md | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/COLLABORATOR_GUIDE.md b/COLLABORATOR_GUIDE.md index fe9d8b79820e91..a488bd2baa0766 100644 --- a/COLLABORATOR_GUIDE.md +++ b/COLLABORATOR_GUIDE.md @@ -87,19 +87,24 @@ All pull requests that modify executable code should be subjected to continuous integration tests on the [project CI server](https://ci.nodejs.org/). -Here is a summary of current CI jobs: +Here are some useful CI jobs: * [`node-test-pull-request`](https://ci.nodejs.org/job/node-test-pull-request/) -is the standard CI run we do to check Pull Requests. It triggers `node-test-commit`, which runs the `build-ci` and `test-ci` targets on all supported platforms. +is the standard CI run we do to check Pull Requests. It triggers `node-test-commit`, +which runs the `build-ci` and `test-ci` targets on all supported platforms. * [`node-test-linter`](https://ci.nodejs.org/job/node-test-linter/) -only runs the linter targets, which is useful for changes that only affect comments or documentation. +only runs the linter targets, which is useful for changes that only affect comments +or documentation. * [`citgm-smoker`](https://ci.nodejs.org/view/Node.js-citgm/job/citgm-smoker/) -uses CitGM to allow you to run npm install && npm test on a large selection of common modules. This is useful to check whether a change will cause breakage in the ecosystem. To test node ABI changes you can run [citgm-abi-smoker](https://ci.nodejs.org/view/Node.js-citgm/job/citgm-abi-smoker/). +uses [CitGM](https://github.com/nodejs/citgm) to allow you to run `npm install && npm test` +on a large selection of common modules. This is useful to check whether a change will +cause breakage in the ecosystem. To test node ABI changes you can run [`citgm-abi-smoker`](https://ci.nodejs.org/view/Node.js-citgm/job/citgm-abi-smoker/). * [`node-stress-single-test`](https://ci.nodejs.org/job/node-stress-single-test/) -is designed to allow one to run a single test over and over on a specific platform to confirm that the test is reliable. +is designed to allow one to run a single test over and over on a specific platform +to confirm that the test is reliable. * [`node-test-commit`](https://ci.nodejs.org/job/node-test-commit/) runs the `build-ci` and `test-ci` targets on all supported platforms. From 7642551adb3cbbcb6353ac870101267bebd0909f Mon Sep 17 00:00:00 2001 From: morrme Date: Fri, 21 Apr 2017 13:25:30 -0500 Subject: [PATCH 5/9] Update COLLABORATOR_GUIDE.md --- COLLABORATOR_GUIDE.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/COLLABORATOR_GUIDE.md b/COLLABORATOR_GUIDE.md index a488bd2baa0766..4650215f6d9938 100644 --- a/COLLABORATOR_GUIDE.md +++ b/COLLABORATOR_GUIDE.md @@ -97,10 +97,10 @@ which runs the `build-ci` and `test-ci` targets on all supported platforms. only runs the linter targets, which is useful for changes that only affect comments or documentation. -* [`citgm-smoker`](https://ci.nodejs.org/view/Node.js-citgm/job/citgm-smoker/) +* [`citgm-smoker`](https://ci.nodejs.org/job/citgm-smoker/) uses [CitGM](https://github.com/nodejs/citgm) to allow you to run `npm install && npm test` on a large selection of common modules. This is useful to check whether a change will -cause breakage in the ecosystem. To test node ABI changes you can run [`citgm-abi-smoker`](https://ci.nodejs.org/view/Node.js-citgm/job/citgm-abi-smoker/). +cause breakage in the ecosystem. To test node ABI changes you can run [`citgm-abi-smoker`](https://ci.nodejs.org/job/citgm-abi-smoker/). * [`node-stress-single-test`](https://ci.nodejs.org/job/node-stress-single-test/) is designed to allow one to run a single test over and over on a specific platform From c23bc2464ec4539215c6726d1904e30a2ba6b41c Mon Sep 17 00:00:00 2001 From: morrme Date: Fri, 21 Apr 2017 13:28:02 -0500 Subject: [PATCH 6/9] doc: update COLLABORATOR_GUIDE.md Fixes: https://github.com/nodejs/node/issues/12021 --- COLLABORATOR_GUIDE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/COLLABORATOR_GUIDE.md b/COLLABORATOR_GUIDE.md index 4650215f6d9938..fbde9023d05947 100644 --- a/COLLABORATOR_GUIDE.md +++ b/COLLABORATOR_GUIDE.md @@ -340,7 +340,7 @@ information regarding the change process: - A `PR-URL:` line that references the *full* GitHub URL of the original pull request being merged so it's easy to trace a commit back to the - conversation that led up to that change. + conversation that led up to that change. - A `Fixes: X` line, where _X_ either includes the *full* GitHub URL for an issue, and/or the hash and commit message if the commit fixes a bug in a previous commit. Multiple `Fixes:` lines may be added if From 696e2aaf96bb71ceb37b3a0a400aa570981f4280 Mon Sep 17 00:00:00 2001 From: morrme Date: Fri, 21 Apr 2017 14:19:35 -0500 Subject: [PATCH 7/9] doc: remove `node-test-commit` from CI jobs list Fixes: #12555 --- COLLABORATOR_GUIDE.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/COLLABORATOR_GUIDE.md b/COLLABORATOR_GUIDE.md index fbde9023d05947..70dba33a461d7d 100644 --- a/COLLABORATOR_GUIDE.md +++ b/COLLABORATOR_GUIDE.md @@ -106,9 +106,6 @@ cause breakage in the ecosystem. To test node ABI changes you can run [`citgm-ab is designed to allow one to run a single test over and over on a specific platform to confirm that the test is reliable. -* [`node-test-commit`](https://ci.nodejs.org/job/node-test-commit/) -runs the `build-ci` and `test-ci` targets on all supported platforms. - ### Internal vs. Public API Due to the nature of the JavaScript language, it can often be difficult to From c18f0b9288600414b6ae11eae55c5310b011a0bf Mon Sep 17 00:00:00 2001 From: morrme Date: Sat, 22 Apr 2017 14:52:21 -0500 Subject: [PATCH 8/9] doc: additional changes to COLLABORATOR_GUIDE.md Fixes: https://github.com/nodejs/node/issues/12021 --- COLLABORATOR_GUIDE.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/COLLABORATOR_GUIDE.md b/COLLABORATOR_GUIDE.md index 70dba33a461d7d..e177c8dfaace7a 100644 --- a/COLLABORATOR_GUIDE.md +++ b/COLLABORATOR_GUIDE.md @@ -87,7 +87,7 @@ All pull requests that modify executable code should be subjected to continuous integration tests on the [project CI server](https://ci.nodejs.org/). -Here are some useful CI jobs: +#### Useful CI Jobs * [`node-test-pull-request`](https://ci.nodejs.org/job/node-test-pull-request/) is the standard CI run we do to check Pull Requests. It triggers `node-test-commit`, @@ -98,7 +98,7 @@ only runs the linter targets, which is useful for changes that only affect comme or documentation. * [`citgm-smoker`](https://ci.nodejs.org/job/citgm-smoker/) -uses [CitGM](https://github.com/nodejs/citgm) to allow you to run `npm install && npm test` +uses [`CitGM`](https://github.com/nodejs/citgm) to allow you to run `npm install && npm test` on a large selection of common modules. This is useful to check whether a change will cause breakage in the ecosystem. To test node ABI changes you can run [`citgm-abi-smoker`](https://ci.nodejs.org/job/citgm-abi-smoker/). @@ -337,7 +337,7 @@ information regarding the change process: - A `PR-URL:` line that references the *full* GitHub URL of the original pull request being merged so it's easy to trace a commit back to the - conversation that led up to that change. + conversation that led up to that change. - A `Fixes: X` line, where _X_ either includes the *full* GitHub URL for an issue, and/or the hash and commit message if the commit fixes a bug in a previous commit. Multiple `Fixes:` lines may be added if From 31ce4010afb71d72fb966f6e0f027a2c958ab3e4 Mon Sep 17 00:00:00 2001 From: morrme Date: Sun, 23 Apr 2017 05:39:51 -0500 Subject: [PATCH 9/9] doc: update CI job descriptions Fixes: https://github.com/nodejs/node/issues/12021 I made the suggested changes and created a navigation link to maintain consistency with other section headings. --- COLLABORATOR_GUIDE.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/COLLABORATOR_GUIDE.md b/COLLABORATOR_GUIDE.md index e177c8dfaace7a..c85165103d5c2d 100644 --- a/COLLABORATOR_GUIDE.md +++ b/COLLABORATOR_GUIDE.md @@ -4,6 +4,7 @@ * [Issues and Pull Requests](#issues-and-pull-requests) * [Accepting Modifications](#accepting-modifications) + - [Useful CI Jobs](#useful-ci-jobs) - [Internal vs. Public API](#internal-vs-public-api) - [Breaking Changes](#breaking-changes) - [Deprecations](#deprecations) @@ -99,12 +100,13 @@ or documentation. * [`citgm-smoker`](https://ci.nodejs.org/job/citgm-smoker/) uses [`CitGM`](https://github.com/nodejs/citgm) to allow you to run `npm install && npm test` -on a large selection of common modules. This is useful to check whether a change will -cause breakage in the ecosystem. To test node ABI changes you can run [`citgm-abi-smoker`](https://ci.nodejs.org/job/citgm-abi-smoker/). +on a large selection of common modules. This is useful to check whether a +change will cause breakage in the ecosystem. To test Node.JS ABI changes +you can run [`citgm-abi-smoker`](https://ci.nodejs.org/job/citgm-abi-smoker/). * [`node-stress-single-test`](https://ci.nodejs.org/job/node-stress-single-test/) -is designed to allow one to run a single test over and over on a specific platform -to confirm that the test is reliable. +is designed to allow one to run a group of tests over and over on a specific +platform to confirm that the test is reliable. ### Internal vs. Public API