Skip to content

Add "Checks" permissions to github-app docs#734

Closed
arogge wants to merge 1 commit into
jenkinsci:masterfrom
arogge:patch-1
Closed

Add "Checks" permissions to github-app docs#734
arogge wants to merge 1 commit into
jenkinsci:masterfrom
arogge:patch-1

Conversation

@arogge
Copy link
Copy Markdown

@arogge arogge commented Sep 29, 2023

Description

the documented permissions were incomplete. To make the plugin actually work, you have to also enable Read/Write permissions on Checks.

Submitter checklist

  • Link to JIRA ticket in description, if appropriate.
  • Change is code complete and matches issue description
  • Automated tests have been added to exercise the changes
  • Reviewer's manual test instructions provided in PR description. See Reviewer's first task below.

Reviewer checklist

  • Run the changes and verify that the change matches the issue description
  • Reviewed the code
  • Verified that the appropriate tests have been written or valid explanation given

Documentation changes

  • Link to jenkins.io PR, or an explanation for why no doc changes are needed

Users/aliases to notify

the documented permissions were incomplete. To make the plugin actually work, you have to also enable Read/Write permissions on Checks.
@arogge arogge requested a review from a team as a code owner September 29, 2023 08:44
@jglick
Copy link
Copy Markdown
Member

jglick commented Sep 29, 2023

To make the plugin actually work, you have to also enable Read/Write permissions on Checks.

Well, technically this plugin does not do anything with Checks, only commit statuses. But you would likely want to combine it with github-checks, which as the name implies does require write permission on Checks. (It is also possible to use another plugin to disable the commit status generated by this plugin, so that you do not actually need commit status permission, if you care.) Anyway, it seems sensible to guide users to enable the most commonly required permissions even if not always necessary.

@jglick
Copy link
Copy Markdown
Member

jglick commented Sep 29, 2023

Best to make that explicit, and also update https://plugins.jenkins.io/github-checks/#plugin-content-features correspondingly.

@arogge arogge closed this Oct 16, 2023
@jglick
Copy link
Copy Markdown
Member

jglick commented Nov 15, 2023

see #746

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants