Skip to content

Commit 16a7ed6

Browse files
committed
Add context to usage example
1 parent d971d08 commit 16a7ed6

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

docker-build/README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,13 +25,18 @@ This GitHub Action is designed to build a Docker container image, providing stan
2525

2626
### Usage
2727

28+
This example demonstrates how to build a Docker container image for a service named `my-service`. The image is:
29+
30+
- Tagged with metadata indicating the target deployment environment (e.g., `dev`, `stage`, `prod`).
31+
- Tagged so that it can be published to both Google Artifact Registry and GitHub Container Registry.
32+
2833
```yaml
2934
- uses: mozilla/deploy-actions/docker-build@v4
3035
with:
3136
image_name: my-service
3237
gar_name: tenant-prod
3338
project_id: moz-fx-tenant-prod
34-
image_tag_metadata: dev
39+
image_tag_metadata: ${{ steps.preflight.outputs.deployment-env }} # resolves to `dev` for the purposes of this example
3540
should_tag_ghcr: true
3641
```
3742

0 commit comments

Comments
 (0)