docs: upgrading

andykenward · Apr 18, 2024 · d54e51f · d54e51f
1 parent 7b3ba1b
commit d54e51f
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -24,6 +24,10 @@ For example manually create two GitHub Environments called "production" & "previ
 github-environemnt: ${{ (github.ref == 'refs/heads/main' && 'production') || 'preview' }}
 ```
 
+## Upgrading
+
+If you have previous deployments using an older version of this GitHub Action please see the [CHANGELOG.md](../CHANGELOG.md) for breaking changes.
+
 ## Permissions
 
 The [permissions] required for this GitHub Action when using the created [`GITHUB_TOKEN`] by the workflow for the `github-token` field.

diff --git a/delete/README.md b/delete/README.md
@@ -11,6 +11,10 @@ On closing the [pull request], all the deployments for that pull request will be
 - Delete GitHub deployment and related comment.
 - Output [job summary] of deletion.
 
+## Upgrading
+
+If you have previous deployments using an older version of this GitHub Action please see the [CHANGELOG.md](../CHANGELOG.md) for breaking changes.
+
 ## Permissions
 
 The [permissions] required for this GitHub Action when using the created [`GITHUB_TOKEN`] by the workflow for the `github-token` field.