ci: Add deployment preview to pull requests via Uffizzi integration

[ShrutiC-git]

New Pull Request Checklist

• I am not disclosing a vulnerability.
• I am creating this PR in reference to an issue.

Approach

This PR is opened as an update to PR #2352. This PR is moving Uffizzi build and Uffizzi preview workloads from GitHub actions to Uffizzi CI.

Uffizzi CI will handle building the containers and provisioning preview environments for PRs. Once the preview is up and ready, a comment will be posted on the PR on GitHub. This requires lesser configuration than GHA integration.

Here is a guide on the Uffizzi CI setup and how it works.

Post merging this PR into Parse's default branch, you'll have to follow these steps to configure Uffizzi CI to provision previews for PRs on Parse-dashboard.

Here is a test PR which was opened in my fork of Parse-dashboard. The building and provisioning were done outside of GHA and in Uffizzi CI. Post completion, this comment was posted on the PR. This is the preview environment. To log into Parse-dashboard for this test PR, use the following credentials:

• username: admin
• password: password

cc @mtrezza

TODOs before merging

• Add tests
• Add changes to documentation (guides, repository pages, in-code descriptions)

[parse-github-assistant]

Thanks for opening this pull request!

• ❌ Please edit your post and use the provided template when creating a new pull request. This helps everyone to understand your post better and asks for essential information to quicker review the pull request.

[mtrezza]

The integration looks much more lightweight now, thanks for the new PR. What's the status of this PR and what would we need to do to add this preview to all PRs of the Parse Dashboard repo? I think we could give this a try.

[ShrutiC-git]

that's great to hear — I'm glad we could align it to meet Parse's requirements :)

• You can start by merging this PR.

• Post that, you'll need to sign up into Uffizzi.com with GitHub.

• After successful login, you could go through these steps to setup Uffizzi CI

And you'll be good to go!

Also, this is how the Uffizzi CI works for now.

Currently Uffizzi CI will only create previews for pull requests that target the branch you configure in the Uffizzi Dashboard (Project > Settings > Compose file > Branch > Path to Compose).

For example, if you configure Uffizzi CI with a Compose file from your main branch, Uffizzi will apply the following logic:
Previews will be triggered for pull requests matching:

main ← {topic_branch}
Previews will not be triggered for pull requests matching:

{topic_branch} ← main or
{topic_branch} ← {topic_branch}

Here are our docs on how to use Uffizzi CI if you want to read more about this.

[mtrezza]

I assume we need to write our own bot to add the preview URL as a comment to the PR thread? Or is that a feature that is already supported?

Post that, you'll need to sign up into Uffizzi.com with GitHub.

I tried that, but got an error:

The repository belongs to an org, but the org account parse-community cannot be used to sign in. Instead, we use another GitHub user parseplatformorg who has access to that org's repositories. When I sign up on Uffizzi with the GitHub account parseplatformorg and then choose "Configure GitHub" I don't see any repositories in the Uffizzi dashboard, because that account doesn't own any. If I choose "Configure GitHub" with the parse-community account that owns the repository Uffizzi shows the error above.

[gadkins]

Hi @mtrezza I'm co-founder at Uffizzi. Happy to help you out.

I assume we need to write our own bot to add the preview URL as a comment to the PR thread? Or is that a feature that is already supported?

No you don't need to write your own bot, Uffizzi CI will post the comment for you. You will grant permission to the Uffizzi GitHub App to write to PR issues, as described here.

It looks like parseplatformorg is technically a GitHub Personal Account, which I assume has Owner role for the parse-community Organizational Account? If that is the case, you should login to Uffizzi as parseplatformorg (Personal), and then create a Uffizzi Team for parse-community (Organizational). Once the parse-community Team is created, you can switch to this context and connect the credentials.

[mtrezza]

Thanks, it found the repository; I'll merge this to continue the configuration in the console.
Continuing discussion in issue #2374.

[parseplatformorg]

🎉 This change has been released in version 5.1.0-alpha.7

[parseplatformorg]

🎉 This change has been released in version 5.1.0-beta.2

[parseplatformorg]

🎉 This change has been released in version 5.1.0