Skip to content

Commit

Permalink
Address review suggestions
Browse files Browse the repository at this point in the history
  • Loading branch information
Dilhasha committed Feb 12, 2024
1 parent 5460ff2 commit 7c1122f
Showing 1 changed file with 6 additions and 7 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -147,32 +147,31 @@ You can deprecate a specific version or all versions of a published package due

### Deprecate all versions of a published package

To change the name of a published package, you can mark all the versions of the existing package as deprecated and then publish the package under a new name.
For example, if you want to change the name of a published package, execute the command below to mark all the versions of the existing package as deprecated and then, publish the package under a new name.

An optional deprecation message can also be included, which will be displayed to current users of the package.
>**Info:** An optional deprecation message can also be included, which will be displayed to current users of the package.
```
$ bal deprecate <org-name>/<package-name> --message <deprecation-message>
```

### Deprecate a specific version of a published package

If you have released a package version containing a critical bug or security vulnerability, it is possible to deprecate that specific version.
For example, if you have released a package version containing a critical bug or security vulnerability, it is possible to deprecate that specific version.

To deprecate a particular version of a package on Ballerina Central, the package owner can run the same command with the package version.

```
$ bal deprecate <org-name>/<package-name>:<version> --message <deprecation-message>
```

If the deprecated package or version is in use, a warning message containing the provided deprecation message will be shown during the project build.

> **Note:** A deprecated package or version will not appear in package searches on Ballerina Central or the CLI. Additionally, it will not be used for dependency
>**Info:** If the deprecated package or version is in use, a warning message containing the provided deprecation message will be shown during the project build.
A deprecated package or version will not appear in package searches on Ballerina Central or the CLI. Additionally, it will not be used for dependency
resolution unless it is already a part of a sticky build or no other compatible package version exists.

### Undo deprecation of a package

To reverse the deprecation of a package, execute the same command with the `--undo` flag.
Execute the command with the `--undo` flag below to reverse the deprecation of a package.

```
$ bal deprecate <org-name>/<package-name>[:<version>] --undo
Expand Down

0 comments on commit 7c1122f

Please sign in to comment.