Add inject example to README

getsentry · Jan 14, 2025 · aab1c91 · aab1c91
1 parent e617c21
commit aab1c91
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -100,13 +100,14 @@ Adding the following to your workflow will create a new Sentry release and tell
 
 ### Examples
 
-- Create a new Sentry release for the `production` environment and upload JavaScript source maps from the `./lib` directory.
+- Create a new Sentry release for the `production` environment, inject Debug IDs into JavaScript source files and sourcemaps and upload them from the `./dist` directory.
 
     ```yaml
     - uses: getsentry/action-release@v1
       with:
         environment: 'production'
-        sourcemaps: './lib'
+        inject: true
+        sourcemaps: './dist'
     ```
 
 - Create a new Sentry release for the `production` environment of your project at version `v1.0.1`.

diff --git a/docs/publishing-a-release.md b/docs/publishing-a-release.md
@@ -5,7 +5,6 @@ The [build.yml](../.github/workflows/build.yml) workflow will build a Docker ima
 > [!WARNING]
 > Merging pull requests into `master` means changes are live for anyone who uses the action regardless of bumping the version.
 > Be extremely careful and intentional with changes and ensure properly testing them before merging, see [#Testing](development.md#testing) for more info.
-effectively being live for everyone even if we do not bump the version.
 
 > [!NOTE]
 > Unfortunately, we only use the `latest` tag for the Docker image, thus, making use of a version with the action ineffective (e.g. `v1` vs `v1.3.0`).