search

okteto / docs

Apache License 2.0
6 stars 19 forks source link

Documentation for Github PR Previews #12

Closed maroshii closed 2 years ago

maroshii commented 2 years ago

As part of the preview environment github integration we need to update the docs to properly document the auto previews PR integration.

This is the page: https://www.okteto.com/docs/cloud/preview-environments/preview-environments-github/

Not sure if the idea is to deprecate the github action or not but we would need to either replace the page or create a new one.

jmacelroy commented 2 years ago

@RinkiyaKeDad can you assist on this one? We are working on getting together a list of permissions we require from GitHub, via oauth, and why we need them. We will be including those perms in an email but we will also need them in the documentation. @maroshii can work with you on an overview of the feature and how it works, also you can use it in staging.

maroshii commented 2 years ago

We request the following permissions:

Screen Shot 2022-02-23 at 8 17 20 PM

PR previews added Pull Request: read & write and Commit Statuses: read & write, all the other permissions where already in place.

Note that upon signing up only the user permission email is requested, for the rest the user needs to install the github app as part of the deploy (dev) or add repo (previews) modal.

The messages below are not meant to be what we show to the user but a guideline to why we need them.

Why do we need them:

Repo

Repo Contents - To clone repos and deploy preview and dev environments from private repositories. Metadata -List repositories for orgs and users. Pull Request (new) - To post PR messages with preview environment info (endpoints, etc) Commit Statuses (new) - To create PR checks for preview environments

Organizations

Members - Requested only for org installations. Not sure exactly why we need them, maybe @ifbyol can shed some light here.

User

Email - During signup. To be able to link the okteto user to the github account.

RinkiyaKeDad commented 2 years ago

Sure I can work on this. Could you please remind me again what the timeline for shipping this feature is?

jmacelroy commented 2 years ago

Sure I can work on this. Could you please remind me again what the timeline for shipping this feature is?

We hope to ship it next week. There are a few tasks we need to finish before the launch. It includes an email and the documentation listed here. We can sync next week to go over details as I need to review and create the final issues.