Skip to content

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

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.

Sign up for GitHub

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 2 commits into from
Aug 1, 2023
Merged

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

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dc1ea5f
docs: Update CONTRIBUTING.md with PR deployments instructions
matifali Aug 1, 2023
65c64ac
update
matifali Aug 1, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions docs/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down