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

feat: ignore .md files when do requiresJenkinsRun check #641

Merged
merged 1 commit into from
Feb 23, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
9 changes: 8 additions & 1 deletion lib/pr_checker.js
Original file line number Diff line number Diff line change
Expand Up @@ -404,6 +404,13 @@ export default class PRChecker {
return false;
}

const files = pr.files.nodes;

// Don't require Jenkins run for doc-only change.
if (files.every(({ path }) => path.endsWith('.md'))) {
return false;
}

const ciNeededFolderRx = /^(deps|lib|src|test)\//;
const ciNeededToolFolderRx =
/^tools\/(code_cache|gyp|icu|inspector|msvs|snapshot|v8_gypfiles)/;
Expand All @@ -416,7 +423,7 @@ export default class PRChecker {
];
const ciNeededExtensionList = ['.gyp', '.gypi', '.bat'];

return pr.files.nodes.some(
return files.some(
({ path }) =>
ciNeededFolderRx.test(path) ||
ciNeededToolFolderRx.test(path) ||
Expand Down
23 changes: 23 additions & 0 deletions test/fixtures/pull_requests/code-change.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
{
"createdAt": "2022-07-12T11:55:42Z",
"authorAssociation": "MEMBER",
"author": {
"login": "F3n67u",
"email": "F3n67u@outlook.com",
"name": "Feng Yu"
},
"url": "https://github.com/nodejs/node/pull/43796",
"bodyHTML": "\n<p dir=\"auto\"><span class=\"issue-keyword tooltipped tooltipped-se\" aria-label=\"This pull request closes issue #43795.\">Fix</span> <a class=\"issue-link js-issue-link\" data-error-text=\"Failed to load title\" data-id=\"1301950808\" data-permission-text=\"Title is private\" data-url=\"https://github.com/nodejs/node/issues/43795\" data-hovercard-type=\"issue\" data-hovercard-url=\"/nodejs/node/issues/43795/hovercard\" href=\"https://github.com/nodejs/node/issues/43795\">#43795</a></p>",
"bodyText": "Fix #43795",
"labels": { "nodes": [{ "name": "http" }] },
"files": { "nodes": [{ "path": "lib/_http_server.js" }] },
"title": "http: check if `socket` is null before destroy",
"baseRefName": "main",
"headRefName": "closeIdleConnections",
"changedFiles": 1,
"mergeable": "MERGEABLE",
"closed": false,
"closedAt": null,
"merged": false,
"mergedAt": null
}
31 changes: 31 additions & 0 deletions test/fixtures/pull_requests/doc-only-in-tools.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
{
"createdAt": "2022-06-19T03:31:58Z",
"authorAssociation": "MEMBER",
"author": {
"login": "F3n67u",
"email": "F3n67u@outlook.com",
"name": "Feng Yu"
},
"url": "https://github.com/nodejs/node/pull/43483",
"bodyHTML": "\n<p dir=\"auto\">unicode-org/icu repo has renamed its default branch to main also, this pr update the link to unicode-org/icu old master branch.</p>",
"bodyText": "unicode-org/icu repo has renamed its default branch to main also, this pr update the link to unicode-org/icu old master branch.",
"labels": {
"nodes": [
{ "name": "tools" },
{ "name": "i18n-api" },
{ "name": "fast-track" },
{ "name": "author ready" },
{ "name": "icu" }
]
},
"files": { "nodes": [{ "path": "tools/icu/README.md" }] },
"title": "tools: update link of `ICU data slicer`",
"baseRefName": "main",
"headRefName": "doc/icu",
"changedFiles": 1,
"mergeable": "UNKNOWN",
"closed": true,
"closedAt": "2022-06-20T09:20:58Z",
"merged": true,
"mergedAt": "2022-06-20T09:20:58Z"
}
86 changes: 86 additions & 0 deletions test/unit/pr_checker.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -923,6 +923,92 @@ describe('PRChecker', () => {
});
});

it('should succeed if doc-only changes in tools dir without Jenkins',
async() => {
const cli = new TestCLI();

const expectedLogs = {
ok: [
['Last GitHub CI successful']
],
info: [
['Green GitHub CI is sufficient']
]
};

const data = {
pr: pullRequests['doc-only-in-tools'],
reviewers: allGreenReviewers,
comments: [],
reviews: approvingReviews,
commits: githubCI['check-suite-success'],
collaborators,
authorIsNew: () => true,
getThread() {
return PRData.prototype.getThread.call(this);
}
};
const checker = new PRChecker(
cli,
data,
{
json: sinon.stub().callsFake(await function() {
return undefined;
})
},
argv);

cli.clearCalls();
const status = await checker.checkCI();
assert(status);
cli.assertCalledWith(expectedLogs, {
ignore: ['startSpinner', 'updateSpinner', 'stopSpinner']
});
}
);

it('should fail if code changes without Jenkins', async() => {
const cli = new TestCLI();

const expectedLogs = {
error: [
['No Jenkins CI runs detected']
],
ok: [
['Last GitHub CI successful']
]
};

const data = {
pr: pullRequests['code-change'],
reviewers: allGreenReviewers,
comments: [],
reviews: approvingReviews,
commits: githubCI['check-suite-success'],
collaborators,
authorIsNew: () => true,
getThread() {
return PRData.prototype.getThread.call(this);
}
};
const checker = new PRChecker(
cli,
data,
{
json: sinon.stub().callsFake(await function() {
return undefined;
})
},
argv);

cli.clearCalls();
const status = await checker.checkCI();
assert(!status);
cli.assertCalledWith(expectedLogs, {
ignore: ['startSpinner', 'updateSpinner', 'stopSpinner']
});
});

it('should succeed if doc-only changes with failed Jenkins', async() => {
const cli = new TestCLI();

Expand Down