Skip to content

Opt-in preview environments #10681

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

Merged
merged 1 commit into from
Jun 20, 2022
Merged

Opt-in preview environments #10681

merged 1 commit into from
Jun 20, 2022

Conversation

vulkoingim
Copy link
Contributor

@vulkoingim vulkoingim commented Jun 15, 2022

Description

Preview environments become optional with a toggle switch in the PR template.

The org-wide PR template is at:
https://github.com/gitpod-io/.github/blob/main/.github/pull_request_template.md

But we only care about modifying the template for this repository - therefore I've added it here and made the change.

Related Issue(s)

Fixes #9899

How to test

Job without with-preview set: https://werft.gitpod-dev.com/job/gitpod-custom-aa-opt-in-prevs.1/logs
Job with with-preview set: https://werft.gitpod-dev.com/job/gitpod-custom-aa-opt-in-prevs.2/logs

Release Notes

NONE

Werft options:

  • /werft with-preview

@werft-gitpod-dev-com
Copy link

started the job as gitpod-build-aa-opt-in-prevs.2 because the annotations in the pull request description changed
(with .werft/ from main)

@vulkoingim
Copy link
Contributor Author

vulkoingim commented Jun 15, 2022

/werft run github -j ./werft/build.yaml -a updateGitHubStatus=gitpod-io/gitpod

👍 started the job as gitpod-build-aa-opt-in-prevs.3
(with .werft/ from main)

@werft-gitpod-dev-com
Copy link

started the job as gitpod-build-aa-opt-in-prevs.4 because the annotations in the pull request description changed
(with .werft/ from main)

@werft-gitpod-dev-com
Copy link

started the job as gitpod-build-aa-opt-in-prevs.5 because the annotations in the pull request description changed
(with .werft/ from main)

@vulkoingim vulkoingim changed the title Aa/opt in prevs Opt-in preview environments Jun 15, 2022
@werft-gitpod-dev-com
Copy link

started the job as gitpod-build-aa-opt-in-prevs.8 because the annotations in the pull request description changed
(with .werft/ from main)

@werft-gitpod-dev-com
Copy link

started the job as gitpod-build-aa-opt-in-prevs.9 because the annotations in the pull request description changed
(with .werft/ from main)

@werft-gitpod-dev-com
Copy link

started the job as gitpod-build-aa-opt-in-prevs.10 because the annotations in the pull request description changed
(with .werft/ from main)

@vulkoingim vulkoingim marked this pull request as ready for review June 17, 2022 12:07
@werft-gitpod-dev-com
Copy link

started the job as gitpod-build-aa-opt-in-prevs.11 because the annotations in the pull request description changed
(with .werft/ from main)

@vulkoingim vulkoingim requested a review from a team June 17, 2022 12:07
Copy link
Contributor

@ArthurSens ArthurSens left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The changes look good!

My only concern is that this is a breaking change to everyone's workflow, but I'm not aware if there was internal discussion around it already 🤔

@meysholdt, do you think we need to bring this up during all-hands/engineering sync before merging?

Would it be less disruptive if the template had the werft with-preview checked by default and people could optionally remove it?

@vulkoingim
Copy link
Contributor Author

vulkoingim commented Jun 17, 2022

The changes look good!

My only concern is that this is a breaking change to everyone's workflow, but I'm not aware if there was internal discussion around it already 🤔

@meysholdt, do you think we need to bring this up during all-hands/engineering sync before merging?

Would it be less disruptive if the template had the werft with-preview checked by default and people could optionally remove it?

Well, the idea is to make them opt-in, not opt-out (see here #9899).

As for announcing it - I was planning on posting in Slack once this gets merged.

@meysholdt
Copy link
Member

meysholdt commented Jun 20, 2022

My only concern is that this is a breaking change to everyone's workflow, but I'm not aware if there was internal discussion around it already 🤔
@meysholdt, do you think we need to bring this up during all-hands/engineering sync before merging?

I did bring it up in an engineering sync and in the sync we found alignment to make preview ends opt-in.
https://www.notion.so/gitpod/Engineering-Sync-164a9fd459374f27ac366c97a4b10c3c#a955b54d699d4ad2aaf29873add3faa4

Would it be less disruptive if the template had the werft with-preview checked by default and people could optionally remove it?

I think it's good how Aleks proposed it: It's disabled by default (resource-friendly) and can easily be enabled. My assumption is that enabling it is not a burden because you get all you need from the PR template and only need to add an X. I also assume that people won't miss the X because they're redacting/enhancing what they got from the template before creating a PR.

@meysholdt
Copy link
Member

meysholdt commented Jun 20, 2022

Thus let's move forward the way Aleks has proposed it: Merge this PR, Aleks announces it on Slack, and I link to Aleks announcement in the all-hands notes.

@werft-gitpod-dev-com
Copy link

started the job as gitpod-build-aa-opt-in-prevs.12 because the annotations in the pull request description changed
(with .werft/ from main)

Copy link
Contributor

@ArthurSens ArthurSens left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Alright let's go :)

@roboquat roboquat merged commit 9484aad into main Jun 20, 2022
@roboquat roboquat deleted the aa/opt-in-prevs branch June 20, 2022 13:46
@gtsiolis
Copy link
Contributor

gtsiolis commented Jun 27, 2022

Thanks for shipping this, @vulkoingim! ✨

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Consider making Preview Envs Opt-In
5 participants