Skip to content
This repository has been archived by the owner on Sep 9, 2019. It is now read-only.

Commit

Permalink
Add docs on automated deploys
Browse files Browse the repository at this point in the history
This commit updates the "Contributing" documentation to cover automated deployment via Travis.
The "Git Protocol" section is updated and the "Deployment" section is broken into a "Automated Deployment" and "Manual Deployment" section.
  • Loading branch information
jmhooper committed Sep 20, 2016
1 parent c413795 commit 97028e1
Showing 1 changed file with 22 additions and 7 deletions.
29 changes: 22 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,13 +31,17 @@ force push on your branch (but not to `master`...please don't force push
`master`).

For a more detailed walk through on how to do this, you can read thoughtbot's
[Git
Protocol](https://github.com/thoughtbot/guides/tree/master/protocol/git#write-a-feature)
[Git Protocol](https://github.com/thoughtbot/guides/tree/master/protocol/git#write-a-feature)
document.

18F-ers can merge their changes into master after getting approval from another
contributor. PRs can be merged manually by merging the branch into `master`
locally and pushing `master` or by using the merge button on GitHub.
18F-ers can merge their changes into `develop` after getting approval from
another contributor. After a PR has been merged into `develop`, it is
automatically deployed to staging by Travis. After changes have been verified on
staging, the commits can be merged into `master` and Travis will deploy the
changes to production.

PRs can be merged manually by merging the branch locally and pushing or by using
the merge button on GitHub.

### Managing time / Updating holidays

Expand Down Expand Up @@ -197,9 +201,20 @@ This will allow you to create and schedule messages.
Note: scheduled messages may not send if you're using over the weekend, which is
due to the business_time gem referenced above.

## Deployment
## Automated Deployment

Dolores is configured to be deployed [automatically via Travis](https://docs.travis-ci.com/user/deployment/script/).

When code is merged and pushed to the `develop` branch and the tests pass,
Travis will deploy the changes to staging. When code is merged and pushed to
`master` and the tests pass, Travis will deploy the changes to production. It is
for this reason that you should verify that changes have taken place and behave
as expected on staging before merging them to master.

## Manual Deployment

Dolores is configured to be deployed with Cloud Foundry as an 18f-er.
If for some reason you need to deploy manually, Dolores can be deployed with
Cloud Foundry by an 18f-er.

Refer to [docs.cloud.gov](https://docs.cloud.gov/getting-started/setup/) for
getting set up with Cloud Foundry.
Expand Down

0 comments on commit 97028e1

Please sign in to comment.