@sentry/craft 1.21.0 → 2.0.0

package/README.md

@@ -526,7 +526,7 @@ contains any one of `preview`, `pre`, `rc`, `dev`,`alpha`, `beta`, `unstable`,
 
 | Name           | Description                                                        |
 | -------------- | ------------------------------------------------------------------ |
-| `GITHUB_TOKEN` | Personal GitHub API token (see https://github.com/settings/tokens) |
+| `GITHUB_TOKEN` | Personal GitHub API token (see <https://github.com/settings/tokens>) |
 
 **Configuration**
 
@@ -617,7 +617,7 @@ like [getsentry/pypi]
 
 | Name           | Description                                                        |
 | -------------- | ------------------------------------------------------------------ |
-| `GITHUB_TOKEN` | Personal GitHub API token (see https://github.com/settings/tokens) |
+| `GITHUB_TOKEN` | Personal GitHub API token (see <https://github.com/settings/tokens>) |
 
 **Configuration**
 
@@ -829,7 +829,7 @@ targets:
 
 ### Sentry Release Registry (`registry`)
 
-The target will update the Sentry release registry repo(https://github.com/getsentry/sentry-release-registry/) with the latest version of the
+The target will update the Sentry release registry repo(<https://github.com/getsentry/sentry-release-registry/>) with the latest version of the
 project `craft` is used with. The release registry repository will be checked out
 locally, and then the new version file will be created there, along with the necessary
 symbolic links.
@@ -904,17 +904,16 @@ targets:
 
 ### Docker (`docker`)
 
-Pulls an existing source image tagged with the revision SHA, and then pushed it
-to a new target tagged with the released version. No release
-assets are required for this target except for the source image at the provided
-source image location so it would be a good idea to add a status check that
-ensures the source image exists, otherwise `craft publish` will fail at the
-`docker pull` step, causing an interrupted publish. This is an issue for other,
-non-idempotent targets, not for the Docker target.
+Copies an existing source image tagged with the revision SHA to a new target
+tagged with the released version. No release assets are required for this target
+except for the source image at the provided source image location so it would be
+a good idea to add a status check that ensures the source image exists, otherwise
+`craft publish` will fail at the copy step, causing an interrupted publish.
+This is an issue for other, non-idempotent targets, not for the Docker target.
 
 **Environment**
 
-`docker` executable (or something equivalent) must be installed on the system.
+`docker` executable (or something equivalent) with BuildKit must be installed on the system.
 
 | Name              | Description                                |
 | ----------------- | ------------------------------------------ |
@@ -1159,8 +1158,7 @@ For this target to work correctly, either `dart` must be installed on the system
 | ------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | `dartCliPath`    | **optional** Path to the Dart CLI. It must be executable by the calling process. Defaults to `dart`.                                                                                            |
 | `packages`       | **optional** List of directories to be released, relative to the root. Useful when a single repository contains multiple packages. When skipped, root directory is assumed as the only package. |
-| `skipValidation` | **optional** Publishes the package without going through validation steps, such as analyzer & dependency checks. This is useful in particular situations when package maintainers know why the validation fails and wish to side step the issue. For example, there may be analyzer issues due to not following the current (latest) dart SDK recommendation because the package needs to maintain the package compatibility with an old SDK version. 
-This option should be used with caution and only after testing and verifying the reported issue shouldn't affect the package. It is advisable to do an alpha pre-release to further reduce the chance of a potential negative impact. |
+| `skipValidation` | **optional** Publishes the package without going through validation steps, such as analyzer & dependency checks. <br /> This is useful in particular situations when package maintainers know why the validation fails and wish to side step the issue. For example, there may be analyzer issues due to not following the current (latest) dart SDK recommendation because the package needs to maintain the package compatibility with an old SDK version. <br /> This option should be used with caution and only after testing and verifying the reported issue shouldn't affect the package. It is advisable to do an alpha pre-release to further reduce the chance of a potential negative impact. |
 
 **Example**