docs: update CONTRIBUTING.md with PR deployments instructions (#8831)

matifali · web-flow · commit b104bb7005f0 · 2023-08-01T16:48:32.000+03:00
* docs: Update CONTRIBUTING.md with PR deployments instructions

* update
diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md
@@ -79,6 +79,24 @@ 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.
+
+> 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.
+
 ### Adding database migrations and fixtures
 
 #### Database migrations
