RFC: Preview Environments Implementation Details

[polamoros]

RFC | Preview Environments Implementation Details

Introduction

Defines some of the technical implementation details for Wing Cloud Preview Environments.

GitHub App

A GitHub App will be created for the integration between GitHub and Wing Cloud (docs).

The configuration of the GitHub App will require the following steps:

Configuring permissions

The GitHub App will need specific permissions to be able to perform the required actions with repositories.

• Repository Permissions
  • Contents - Read
    • This permission is essential for accessing the .main.w entry points within PRs.
  • Pull Requests - Read and Write
    • This permission is required to create comments containing the fly.io link.

Webhook Configuration

The GitHub App will need to subscribe to specific events through webhook URLs. The following configurations will be applied:

• Webhook URL:
  • https://wing.cloud/api/v1/github/webhook
• Events:
  • Pull Request

The GitHub App will be installed at the organization level. Upon installation, all PRs within the repositories accessible by the GitHub App will automatically have Preview Environments enabled.

GitHub Sign Up / Log In

The GitHub App will be used for the user sign-up and log-in processes. docs.

The login flow is defined further in the documentation, available here.

To generate a user access token, a callback URL must be added to the GitHub App's configuration:

• Callback URL: https://wing.cloud/github/callback
• An example about how to generate a user access token is provided here.

Storage of users

TBD

Storage of fly.io links

TBD

Storage of Environment Variables

TBD

DNS Resource

TBD

[ainvoner]

@polamoros what do you want to do with this issue?

[polamoros]

@polamoros what do you want to do with this issue?

We can close it