synced/coder
1
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2025-07-18 14:17:22 +00:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source 
* docs: Update CONTRIBUTING.md with PR deployments instructions

* update
This commit is contained in:
Muhammad Atif Ali
2023-08-01 16:48:32 +03:00
committed by GitHub
parent dcc63aec90
commit b104bb7005
1 changed files with 18 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
docs/CONTRIBUTING.md
View File

@ -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