Skip to content
This repository has been archived by the owner on Sep 29, 2023. It is now read-only.

Add additional details for Configuring GitHub app #429

Merged
merged 7 commits into from
Sep 11, 2023
Merged

Conversation

stnguyen90
Copy link
Contributor

@stnguyen90 stnguyen90 commented Sep 8, 2023

What does this PR do?

  • Add Where can this GitHub App be installed? to Configuring GitHub app so that you can install in multiple projects
  • Update Callback URL for Configuring GitHub app to emphasize the importance of order
  • Add homepage URL to Configuring GitHub app for completness
  • Add GitHub App name to Configuring GitHub App to clarify how it's used
  • Update _APP_VCS_GITHUB_PRIVATE_KEY docs to give a clear example
  • Add an example section for github env vars

Test Plan

localhost_2080_docs_configuration

Related PRs and Issues

Have you read the Contributing Guidelines on issues?

Yes

@stnguyen90 stnguyen90 requested a review from gewenyu99 September 8, 2023 15:29
@stnguyen90 stnguyen90 changed the title Feat GitHub config Add additional details for Configuring GitHub app Sep 8, 2023
@stnguyen90 stnguyen90 linked an issue Sep 9, 2023 that may be closed by this pull request
2 tasks
@stnguyen90
Copy link
Contributor Author

This should probably be Events:

@stnguyen90
Copy link
Contributor Author

Sample experience where wrong key was used
https://discord.com/channels/564160730845151244/1149769628994781274/1150136044377870346

An example is helpful because some people were putting the SHA256 of
their key instead of the actual key.

It's important for the value to be in 1 line because, as of today, the
upgrade only handles the .env file one line at a time.
Highlight the importance of the app name in relation to the
_APP_VCS_GITHUB_APP_NAME environment variable.
It's also helpful to point out this can be anything the user wants.
Emphasize the importance of the order since an incorrect order won't
work.
This is important to allow GitHub installation across multiple Appwrite
projects.
It's easy to miss that there are 2 events to enable since there's only
1 row. Making the header plural can help point out there are multiple.
Separating the env vars from the table makes it look cleaner.
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Clarify _APP_VCS_GITHUB_PRIVATE_KEY env var
2 participants