From dc1ea5f264d462655abfa0aadf6b35b9df716c29 Mon Sep 17 00:00:00 2001 From: Muhammad Atif Ali Date: Tue, 1 Aug 2023 15:08:54 +0300 Subject: [PATCH 1/2] docs: Update CONTRIBUTING.md with PR deployments instructions --- docs/CONTRIBUTING.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index da8a73b4c6676..7b7362b617fef 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -79,6 +79,22 @@ Use the following `make` commands and scripts in development: - Access `http://localhost:8080` - The default user is `admin@coder.com` and the default password is `SomeSecurePassword!` +### Deploying a PR + +You can test your changes by creating a PR deployment. A PR deployment can be triggered in two ways: + +1. By commenting on the PR with `/deploy-pr` +2. By running `./scripts/deploy-pr.sh` +3. Available options + - `-s` or `--skip-build`, the image will not be built again, and the last image will be used. + - `-e EXPERIMENT1,EXPERIMENT2` or `--experiments EXPERIMENT1,EXPERIMENT2`, will enable the specified experiments. + - `-n` or `--dry-run` will display the context without deployment. e.g., branch name and PR number, etc. + - `-y` or `--yes`, will skip the CLI confirmation (only valid for the `./scripts/deploy-pr.sh`) + +> Note: all flags can be used with both `./scripts/deploy-pr.sh` and `/deploy-pr` comment on the PR, + +Once the deployment is finished, a unique link and credentials will be posted in the [#pr-deployments](https://codercom.slack.com/archives/C05DNE982E8) Slack channel. + ### Adding database migrations and fixtures #### Database migrations From 65c64ac461bf42c4654f3933dcdcca0615e15695 Mon Sep 17 00:00:00 2001 From: Atif Ali Date: Tue, 1 Aug 2023 13:43:10 +0000 Subject: [PATCH 2/2] update --- docs/CONTRIBUTING.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 7b7362b617fef..0bdaaa5be78ff 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -86,12 +86,14 @@ You can test your changes by creating a PR deployment. A PR deployment can be tr 1. By commenting on the PR with `/deploy-pr` 2. By running `./scripts/deploy-pr.sh` 3. Available options - - `-s` or `--skip-build`, the image will not be built again, and the last image will be used. - - `-e EXPERIMENT1,EXPERIMENT2` or `--experiments EXPERIMENT1,EXPERIMENT2`, will enable the specified experiments. - - `-n` or `--dry-run` will display the context without deployment. e.g., branch name and PR number, etc. - - `-y` or `--yes`, will skip the CLI confirmation (only valid for the `./scripts/deploy-pr.sh`) + - `-s` or `--skip-build`, the image will not be built again, and the last image will be used. + - `-e EXPERIMENT1,EXPERIMENT2` or `--experiments EXPERIMENT1,EXPERIMENT2`, will enable the specified experiments. + - `-n` or `--dry-run` will display the context without deployment. e.g., branch name and PR number, etc. + - `-y` or `--yes`, will skip the CLI confirmation (only valid for the `./scripts/deploy-pr.sh`) -> Note: all flags can be used with both `./scripts/deploy-pr.sh` and `/deploy-pr` comment on the PR, +> Note: all flags can be used with both `./scripts/deploy-pr.sh` and `/deploy-pr` comment on the PR. + +> You need to be a member or collaborator of the of [coder](github.com/coder) GitHub organization to be able to deploy a PR. Once the deployment is finished, a unique link and credentials will be posted in the [#pr-deployments](https://codercom.slack.com/archives/C05DNE982E8) Slack channel.