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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enhance GitHub app error messaging and support Base64 encoded keys #2129

Open
jstvz opened this issue Jun 2, 2023 · 1 comment
Open

Enhance GitHub app error messaging and support Base64 encoded keys #2129

jstvz opened this issue Jun 2, 2023 · 1 comment
Labels
enhancement New feature or request wi-created

Comments

@jstvz
Copy link
Contributor

jstvz commented Jun 2, 2023

A user encountered difficulties while using Metecho on Docker, specifically in creating projects and authenticating. Despite correctly configuring permissions and populating the .env file, they received error messages:

  1. "We couldn’t find any Projects you have access to on GitHub. Confirm that you are logged into the correct account or contact an admin on GitHub."
  2. "You are not a member of any GitHub Organization with permissions to create new Projects on Metecho. Confirm that you are logged into the correct account or contact an admin on GitHub."
  3. "GitHub App has not been installed on this organization"

The problem was identified as an additional newline character \n in the DOCKER_GITHUB_APP_KEY, leading to authentication issues.

Occasionally, developers incorrectly format other private keys, resulting in similar problems. This indicates a wider issue related to key handling.

Suggested Improvement:

  1. Improve error messaging related to the GitHub app to provide more descriptive and helpful guidance for identifying potential problems with key formatting or content. The messages should include checks for common mistakes like extra characters, spaces, or newline characters.

  2. Add support for Base64 encoded keys to help avoid the problem of incorrect formatting. This improvement would make the integration more resilient and tolerant of minor formatting errors in private keys, ultimately reducing user frustration and the need for support assistance.

@jstvz jstvz added enhancement New feature or request wi-created labels Jun 2, 2023
@jstvz
Copy link
Contributor Author

jstvz commented Jun 2, 2023

Tracked in:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request wi-created
Projects
None yet
Development

No branches or pull requests

1 participant