doc: add note on visibility of CI failures to new contributor guide#64256
doc: add note on visibility of CI failures to new contributor guide#64256sxa wants to merge 2 commits into
Conversation
Signed-off-by: Stewart X Addison <sxa@ibm.com>
|
Review requested:
|
|
FYI @MikeMcC399 as someone who has experienced this recently :-) LMK what you think of the wording. I've tried to keep it short but with the info that's needed. |
| Since read access to the CI is also restricted, one of the collaborators also will need to let | ||
| you know about any failures unless you are a member of one of the platform teams in the Node.js | ||
| organisation. If after a day or so from a collaborator triggering a CI your PR shows a failure | ||
| in either the `node-test-pull-request` or `node-test-commit-*` checks it's worth adding a | ||
| comment to the PR asking what tests are failed, as the collaborator may not realise that you | ||
| cannot see the results directly in the CI. |
There was a problem hiding this comment.
In this section, I'd suggest referring specifically to the Jenkins CI. There is no restriction on viewing the GitHub Actions CI.
I would also remove the reference to "unless you are a member of one of the platform teams in the Node.js
organisation" since this is a document for first-time contributors.
I did actually bring up this issue when the original PR was submitted.
See #63685 (comment)
There was a problem hiding this comment.
Fair on the CI clarification - I tend to always be referring to "CI" as the jenkins CI as distinct the "GHA checks" or similar, but I appreciate that's probably more of a "me" thing so I'll add "Jenkins" in there :-)
Ref the platform teams I did consider that but it's possible that someone would be added to a platform team for triage who hasn't directly contributed a fix themselves. It also means that it calls out another mechanism for such contributors to be able to access the jenkins CI if they are volunteering to be part of a platform team. So maybe it's a bit of extra noise in here, but potentially useful noise. I'd be ok either way butso I'll leave it in case other reviewers have an opinion.
Signed-off-by: Stewart X Addison <sxa@ibm.com>
5 participants
Some new contributors won't be able to access the CI and will only see github check failures when a test run in jenkins fails we should make it clear that they will need assistance from a collaborator/platform team member to know which tests caused it to fail.