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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update github-integration.adoc #8407

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update github-integration.adoc #8407

wants to merge 1 commit into from

Conversation

e-grapp
Copy link
Contributor

@e-grapp e-grapp commented Oct 12, 2023

Description

A brief description of the changes.

Add a mention of Env Vars for write access since we mention SSH keys and no mentions of permissions needed elsewhere

Reasons

A link to a GitHub and/or JIRA issue (if applicable).

User wrote in about this in a ticket
https://circleci.zendesk.com/agent/tickets/140038

Content Checklist

Please follow our style when contributing to CircleCI docs. Our style guide is here: https://circleci.com/docs/style/style-guide-overview.

Please take a moment to check through the following items when submitting your PR (this is just a guide so will not be relevant for all PRs) 馃樃:

  • Break up walls of text by adding paragraph breaks.
  • Consider if the content could benefit from more structure, such as lists or tables, to make it easier to consume.
  • Keep the title between 20 and 70 characters.
  • Consider whether the content would benefit from more subsections (h2-h6 headings) to make it easier to consume.
  • Check all headings h1-h6 are in sentence case (only first letter is capitalized).
  • Is there a "Next steps" section at the end of the page giving the reader a clear path to what to read next?
  • Include relevant backlinks to other CircleCI docs/pages.

@e-grapp e-grapp requested a review from a team October 12, 2023 22:52
@@ -60,6 +60,7 @@ CircleCI requests the following permissions from GitHub, defined in the link:htt

- Get a list of a user's repos
- Add an SSH key to a user's account
- Add Environment Variables to Project Settings
Copy link
Contributor

Choose a reason for hiding this comment

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

@e-grapp So my understanding is this is a list of things CircleCI can do on a user's behalf once they have these permissions. Rather than listing things the user is able to do. Maybe there's a better way to surface this 馃 Does that make sense?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@rosieyohannan - apologies for delay on this!

Totally makes sense and I think you're correct that this isn't the best way to surface this as this is more of what CircleCI can do on behalf of user

We have an equivalent for Apps/GL but not exactly for OAuth integrations and I'm thinking an equivalent would be the best approach for this:

https://circleci.com/docs/roles-and-permissions-overview/

Copy link
Contributor

Choose a reason for hiding this comment

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

Oh interesting! Thanks, I'll turn this into a Jira and then close the PR

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants