From 5502ae950505417315c04d2a47dd7471675de21b Mon Sep 17 00:00:00 2001 From: Tobias Babin <140624220+TobiasBabin@users.noreply.github.com> Date: Wed, 29 May 2024 07:52:49 +0200 Subject: [PATCH] Updated description on "notify" action --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 018e090..18c031d 100644 --- a/README.md +++ b/README.md @@ -77,9 +77,9 @@ jobs: action: delete github-token: ${{ secrets.GITHUB_TOKEN }} ``` -### Notify Humanitec +### Notify GitHub Environment -Add the following snipped after your CI step to notify Humanitec about the newly pushed image (commonly the build-push-to-humanitec step): +Add the following snipped after your CI step (commonly the [build-push-to-humanitec](https://github.com/humanitec/build-push-to-humanitec) step) to notify the underlying [GitHub Environment](https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment) about the newly pushed image. When the `environment-url-template` parameter is provided, GitHub will display a "View Deployment" button for convenient access to the preview environment using the generated URL. ```yaml - uses: humanitec/preview-envs-action@v2