Skip to content

doc: add descriptions of CI jobs #12555

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.

Sign up for GitHub

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

Closed
morrme wants to merge 10 commits into from
Closed

doc: add descriptions of CI jobs #12555

Changes from 3 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
5788c98
Update COLLABORATOR_GUIDE.md
morrme Apr 19, 2017
e8897e0
Update COLLABORATOR_GUIDE.md
morrme Apr 19, 2017
bc520c7
update job definitions
morrme Apr 20, 2017
c94b070
doc: update COLLABORATOR_GUIDE.md
morrme Apr 21, 2017
7642551
Update COLLABORATOR_GUIDE.md
morrme Apr 21, 2017
c23bc24
doc: update COLLABORATOR_GUIDE.md
morrme Apr 21, 2017
696e2aa
doc: remove `node-test-commit` from CI jobs list
morrme Apr 21, 2017
c18f0b9
doc: additional changes to COLLABORATOR_GUIDE.md
morrme Apr 22, 2017
31ce401
doc: update CI job descriptions
morrme Apr 23, 2017
5f0eb87
Merge branch 'master' into doc-ci-jobs
morrme May 9, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions COLLABORATOR_GUIDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,23 @@ 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:
Copy link
Copy Markdown
Member

@gibfahn gibfahn Apr 21, 2017

Choose a reason for hiding this comment

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

Maybe:

Here are some useful CI jobs:

We don't want to imply that this is an exhaustive list.


* [`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/)
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/)
Copy link
Copy Markdown
Member

@richardlau richardlau Apr 21, 2017

Choose a reason for hiding this comment

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

This could be the shorter https://ci.nodejs.org/job/citgm-smoker/ if you omit the view/Node.js-citgm. Same for citgm-abi-smoker later in this paragraph.

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/).
Copy link
Copy Markdown
Member

@gibfahn gibfahn Apr 21, 2017 •
edited
Loading

Choose a reason for hiding this comment

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

Maybe add a link to CitGM:

CitGM -> [CitGM](https://github.com/nodejs/citgm)

Backticks:

npm install && npm test -> npm install && npm test

For consistency:

[citgm-abi-smoker] -> [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.

* [`node-test-commit`](https://ci.nodejs.org/job/node-test-commit/)
Copy link
Copy Markdown
Member

@richardlau richardlau Apr 21, 2017

Choose a reason for hiding this comment

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

Is this job intended to be manually run, as opposed to being started by node-test-pull-request? If there isn't a good use case for running this job without running node-test-pull-request then I would be inclined not to include it as a separate bullet point.

Copy link
Copy Markdown
Member

@gibfahn gibfahn Apr 21, 2017

Choose a reason for hiding this comment

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

It is sometime manually run when people just want to test a commit rather than a Pull Request. I don't think there's any particular reason to, as you can just choose not to rebase, which is all node-test-pull-request really does before starting node-test-commit. So it probably does make sense not to include it for now. If someone has a good reason to re-add it, they can do it later.

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
Expand Down