Skip to content

Update staging and add deploy instructions to README #760

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 3 commits into from
May 20, 2021
Merged

Update staging and add deploy instructions to README #760

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3b0b0db
Update README.md
amyrlam May 20, 2021
f1516e0
Update README.md
amyrlam May 20, 2021
a11ecf5
Update instructions to link to existing
amyrlam May 20, 2021
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
5 changes: 2 additions & 3 deletions DEPLOYING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,9 @@ branch," and select the branch you wish to deploy to staging.

First, deploy the `master` branch to staging following the steps above, and check it over thoroughly. Get a second person to look it over too. There are many variables that could affect how an app displays in production compared to locally, particularly for this app.

Never click the "promote to production" button on Heroku. We shouldn't promote from staging with this button because Heroku uses the same build from staging in the production container. This would mean that the variables set during ember builds get reused. Some of these variables have different values between staging and production, which leads to issues.
**Never click the "promote to production" button on Heroku.** We shouldn't promote from staging with this button because Heroku uses the same build from staging in the production container. This would mean that the variables set during ember builds get reused. Some of these variables have different values between staging and production, which leads to issues.

To deploy properly to production, click on the arrows for the `ember-api-docs` instance under Production,
choose "Deploy a branch" and choose the branch name.
To deploy properly to production, click on the arrows for the `ember-api-docs` instance under Production, choose "Deploy a branch" and choose the branch name.

### Rolling back to an earlier version

Expand Down
11 changes: 6 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,16 +51,17 @@ View at http://localhost:4200

To run a11y tests, run `test_a11y=yes ember serve`

## Staging Environment
Latest changes from master can be seen on https://ember-api-docs-frontend-staging.global.ssl.fastly.net/

### Linting
## Linting

* `yarn run lint:hbs`
* `yarn run lint:js`
* `yarn run lint:js -- --fix`

### Building
## Staging and Deployment

See the [DEPLOYING.md](https://github.com/ember-learn/ember-api-docs/blob/master/DEPLOYING.md) guide for instructions.

## Building

Cross-browser testing provided by:

Expand Down