docs: clarify GitHub OAuth vs GitHub App setup and required app settings#300
Open
brone1323 wants to merge 1 commit into
Open
docs: clarify GitHub OAuth vs GitHub App setup and required app settings#300brone1323 wants to merge 1 commit into
brone1323 wants to merge 1 commit into
Conversation
- Add a note distinguishing GitHub OAuth App (sign-in) from GitHub App (GitHub Service / issue sync), since both use a GITHUB_CLIENT_SECRET env var with different names, which has caused user confusion (hcengineering#296, hcengineering#297) - Add yaml snippet showing exactly which service gets GITHUB_CLIENT_ID and GITHUB_CLIENT_SECRET for OAuth - Document the three required GitHub App checkboxes that must be enabled during app creation (Expire user authorization tokens, Request user authorization during installation, Redirect on update) and the uninstall/reinstall recovery path if they were missed (hcengineering#297) - Restructure GitHub App Prerequisites into subsections for clarity
|
Connected to Huly®: SELFH-299 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Addresses confusion reported in #296 and #297 where users spent hours debugging the GitHub integration because:
GITHUB_CLIENT_SECRET, but for different services. Added a callout box at the top of each section making this explicit, and added a concrete yaml snippet showing which service gets which variables.Changes
README.md: Added[!NOTE]callout to GitHub OAuth section clarifying it uses a GitHub OAuth App (not a GitHub App), with variable names shown in a yaml blockREADME.md: Added[!NOTE]callout to GitHub Service section with the same disambiguationREADME.md: Split GitHub Service Prerequisites into "Required GitHub App settings" and "Credentials to collect" subsections; listed the three mandatory checkboxes with an[!IMPORTANT]recovery pathTest plan