Skip to content

Commit 0205705

Browse files
authored
Add deployment instructions to README (#6936)
1 parent 9fcb64d commit 0205705

File tree

1 file changed

+31
-4
lines changed

1 file changed

+31
-4
lines changed

README.md

Lines changed: 31 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -182,11 +182,38 @@ To perform a build run the following command with `--env` being one of the follo
182182
$ npx gulp build --env <environment>
183183
```
184184
185-
This command builds all parts of the project and might take a while. Usually, all builds on [amp-dev-staging.appspot.com](https://amp-dev-staging.appspot.com/) and [amp.dev](https://amp.dev/) are built using [Travis CI](https://travis-ci.org/ampproject/amp.dev). In case you want to reproduce one of those remote builds in your local environment, you can fetch the build artifacts by running:
185+
## Deployment
186186
187-
```sh
188-
$ npx gulp fetchArtifacts --travis-build <build_number>
189-
```
187+
The amp.dev site uses GitHub Actions for automated deployments to both staging and production environments.
188+
189+
### Deployment Environments
190+
191+
- **Staging**: [staging-amp-dev.netlify.app](https://staging-amp-dev.netlify.app/)
192+
- **Production**: [amp.dev](https://amp.dev/)
193+
194+
### How to Deploy
195+
196+
Deployments are triggered through GitHub Actions workflows:
197+
198+
1. **Staging Deployment**:
199+
- Triggered automatically on pushes to the `main` branch
200+
- Automatically builds and deploys to the staging environment
201+
- View workflow status with the "Staging" badge at the top of this README
202+
203+
2. **Production Deployment**:
204+
- **Manual deployment only** - no automatic triggers
205+
- Must be manually triggered through GitHub Actions
206+
- View workflow status with the "Production" badge at the top of this README
207+
208+
### Manual Deployment
209+
210+
To manually trigger a deployment (required for production):
211+
212+
1. Navigate to the [deploy workflow](https://github.com/ampproject/amp.dev/actions/workflows/deploy.yaml) in the GitHub actions tab.
213+
2. Click "Run workflow" and choose the branch you want to deploy
214+
3. Confirm the deployment
215+
216+
**Note**: Ensure your changes have been properly tested in the staging environment before deploying to production.
190217
191218
---
192219

0 commit comments

Comments
 (0)