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>
joyeecheung
left a comment
joyeecheung
left a comment
There was a problem hiding this comment.
I think this can be its own question
| Since read access to the Jenkins 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 Jenkins CI your PR shows a |
There was a problem hiding this comment.
| Since read access to the Jenkins 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 Jenkins CI your PR shows a | |
| ### Q: The Jenkins CI failed, but when I clicked the CI link, it shows "Access Denied". What should I do? | |
| Read access to the Jenkins CI is restricted to a few teams in the Node.js organization. You will | |
| need to ask a member of these teams (for example, any of the collaborators) to show you the details | |
| of the failures. If after a day or so from a collaborator triggering a Jenkins CI your PR shows a |
There was a problem hiding this comment.
I think that's a good suggestion. I set a system message on Jenkins when we restricted access, which I think should get displayed to people without access -- the message could be amended to link to the question in this markdown.
There was a problem hiding this comment.
That would be nice, but it's not what I'm seeing
There was a problem hiding this comment.
😞. @MikeMcC399 It was dismissible -- did you ever dismiss it?
I've made it un-dismissible now. The feedback when we started using it when we did security lockdowns was that the messages were visible: nodejs/build#4203 (comment)
6 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.