Skip to content

Commit 3b7f5f3

Browse files
Update documentation for new release process
1 parent 77fe9bd commit 3b7f5f3

File tree

5 files changed

+23
-46
lines changed

5 files changed

+23
-46
lines changed

documentation/api/guides/deploy.md

Lines changed: 4 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,10 @@
44
For more information on how deployments work, please see the [general deployment guide](/general/deployment.md).
55
```
66

7-
1. Visit
8-
[https://api-staging.openverse.engineering/version](https://api-staging.openverse.engineering/version)
9-
and
10-
[the API Docker image](https://github.com/wordpress/openverse/pkgs/container/openverse-api).
11-
Verify that the commit SHA live on the staging site is also tagged with
12-
`latest` in the Docker image.
13-
![GitHub package directory screenshot](/_static/package_directory_example.png)
14-
1. Release the app via
15-
[GitHub workflow](https://github.com/WordPress/openverse/actions/workflows/release-app.yml).
16-
Click the "Run workflow" button, choose "api" from the dropdown, and supply
17-
the SHA identified in step 1.
7+
1. [Publish the drafted API release in the GitHub release page of the monorepo](https://github.com/WordPress/openverse/releases?q=api-)
8+
- Here you can preview the changes included in the API release and decide
9+
whether a release is necessary and adjust monitoring during the deployment
10+
accordingly.
1811
1. That's it! The API will be deployed. You can monitor the deployment in the
1912
maintainers `#openverse-notifications` channel and in the
2013
[infrastructure repository's workflow listing](https://github.com/WordPress/openverse-infrastructure/actions).

documentation/catalog/guides/deploy.md

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,10 @@
1313
unpause it back.
1414
```
1515

16-
1. Visit the
17-
[Catalog Docker image](https://github.com/WordPress/openverse/pkgs/container/openverse-catalog)
18-
page and copy the SHA of the image tagged `latest`.
19-
1. Release the app via
20-
[GitHub workflow](https://github.com/WordPress/openverse/actions/workflows/release-app.yml).
21-
Click the "Run workflow" button, choose "catalog" from the dropdown, and
22-
supply the SHA identified in the previous step
16+
1. [Publish the drafted catalog release in the GitHub release page of the monorepo](https://github.com/WordPress/openverse/releases?q=catalog-)
17+
- Here you can preview the changes included in the catalog release and decide
18+
whether a release is necessary and adjust monitoring during the deployment
19+
accordingly.
2320

2421
## Deployment
2522

documentation/frontend/guides/deploy.md

Lines changed: 4 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,10 @@
44
For more information on how deployments work, please see the [general deployment guide](/general/deployment.md).
55
```
66

7-
1. Visit
8-
[https://staging.openverse.org/version.json](https://staging.openverse.org/version.json)
9-
and
10-
[the frontend Docker image](https://github.com/wordpress/openverse/pkgs/container/openverse-frontend).
11-
Verify that the commit SHA live on the staging site is also tagged with
12-
`latest` in the Docker image.
13-
![GitHub package directory screenshot](/_static/package_directory_example.png)
14-
1. Release the app via
15-
[GitHub workflow](https://github.com/WordPress/openverse/actions/workflows/release-app.yml).
16-
Click the "Run workflow" button, choose "frontend" from the dropdown, and
17-
supply the SHA identified in step 1.
7+
1. [Publish the drafted frontend release in the GitHub release page of the monorepo](https://github.com/WordPress/openverse/releases?q=frontend-)
8+
- Here you can preview the changes included in the frontend release and
9+
decide whether a release is necessary and adjust monitoring during the
10+
deployment accordingly.
1811
1. That's it. The frontend will be deployed. You can monitor the deployment in
1912
the maintainers `#openverse-notifications` channel and in the
2013
[infrastructure repository's workflow listing](https://github.com/WordPress/openverse-infrastructure/actions).

documentation/general/deployment.md

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -143,21 +143,18 @@ the process above. The staging deployment workflows
143143

144144
## Production
145145

146-
Maintainers manually dispatch the production deployment via the
147-
[Release app](https://github.com/WordPress/openverse/actions/workflows/release-app.yml)
148-
workflow. The workflow requires the tag of an existing Docker image to tag as
149-
the "released" image. It generates a date-based tag for the specific application
150-
being released, publishes a GitHub Release (which creates a git tag), tags the
151-
Docker image, and then triggers the deployment workflow. The workflow also opens
152-
a PR to add the changelog to the
146+
Maintainers begin the production deployment process by publishing the drafted
147+
release for an application. Publishing a release automatically tags the latest
148+
docker image for the application and opens a PR to add the changelog to the
153149
[documentation site's changelog directory](https://docs.openverse.org/changelogs/index.html).
154150
This needs to be manually approved and merged by maintainers. The person who
155151
triggers the release app workflow is pinged in the PR description to help with
156152
the visibility of the PR.
157153

158-
The same workflow is used to create production release images for the ingestion
159-
server. In that case the production deployment still needs to be handled via
160-
Terraform.
154+
For the API and frontend, publishing the release also triggers an automated
155+
production deployment. For the catalog and ingestion server, however,
156+
maintainers must manually deploy the changes to production using the Terraform
157+
deployment process.
161158

162159
## Rollbacks
163160

documentation/ingestion_server/guides/deploy.md

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,10 @@
44

55
1. Check [Airflow](https://airflow.openverse.engineering/home?tags=data_refresh)
66
to make sure a data refresh isn't occurring.
7-
1. Visit the
8-
[Ingestion Server Docker image](https://github.com/WordPress/openverse/pkgs/container/openverse-ingestion_server)
9-
page and copy the SHA of the image tagged `latest`.
10-
1. Release the app via
11-
[GitHub workflow](https://github.com/WordPress/openverse/actions/workflows/release-app.yml).
12-
Click the "Run workflow" button, choose "ingestion_server" from the dropdown,
13-
and supply the SHA identified in the previous step.
7+
1. [Publish the drafted ingestion server release in the GitHub release page of the monorepo](https://github.com/WordPress/openverse/releases?q=ingestion_server-)
8+
- Here you can preview the changes included in the ingestion server release
9+
and decide whether a release is necessary and adjust monitoring during the
10+
deployment accordingly.
1411

1512
## Deployment
1613

0 commit comments

Comments
 (0)