Enabling GitHub App Authentication

[Beridar]

What product are you having troubles with?

Console

What Console version are you using?

13.6.2

Description

We are currently trying to configure GitHub App Authentication in our on-prem install. Our Project template has an Archive URL that points to a release asset that is not publicly available and requires authentication to access. Creating a project with GitHub App Authentication enabled generates the error described below.

We did not receive this error when we had another Provider configured that used Token authentication. Having a different Provider available with valid Token auth seemed to allow the Console to retrieve the project archive and use it to create the project. Similarly, using an expired PAT for Token auth prevented the Console from retrieving the project archive and we could not create projects.

We've reviewed the GitHub API documentation and found two API calls we think are related to this -- get a release asset and list release assets. Both require the "Contents" repository permissions (read), which the GitHub app we're using already has.

Are there any other steps we need to be following to set up GitHub App Authentication so we can retrieve a non-public asset for the project archive?

Actual Outcome

When GitHub App Authentication is the only valid auth method to GitHub, then we receive the following error when creating a project:

Expected Outcome

No response

[Danielecina]

Hi @Beridar, let's try to replicate this issue to give you a correct answer and to see if there are any bugs.
I will update you soon.
Thank you

[Danielecina]

Here I am. Sorry @Beridar for the wait.
I analyzed the problem and was able to reproduce it.

To replicate it I did the following procedures:

1. created a private project template covered by the Github App
2. created a project with the provider authenticated to the same Github App as the template

To Fix the problem:

1. The template created documentation side talks about a public url where download the .tar.gz, however it cannot work if the template is private. We will improve the documentation about this soon.
2. The template, from the CMS, needs to have populated a field that does not yet appear in the current Console frontend yet. (This is a part of the product evolution planned for the future). The template field is called providerID. It needs to be configured by putting the providerId configured. In this case the Provider where the GithubApp is configured.

ProjectTemplate:	Providers:

3. The template needs to have as archiveURL an Github API like this https://api.github.com/repos/{owner}/{repo}/tarball/main?type=.tar.gz

• Is important that the APIbaseUrl of the Github provider in Console Providers section, is the same of the baseUrl used to archiveURL of the project template. Using my example is api.github.com
• The query parameter type=.tar.gz is needed temporarily for the console to work correctly

Example of archive url	Provider api base url

By doing this and giving the right permissions to the Github App you will be able to create projects without problems.
Let me know if you were able to get unblocked this way.
We will try to improve in future releases.
👋

[KarissaBrummell]

Hello, thank you for looking into this. We will try these things and report back soon to see if that resolved our issue.

[Danielecina]

Hello, @KarissaBrummell, Do you have any news about this?
We apologize again for the issues you encountered and hope this has helped you resolve the situation.