@starship-ci/client - npm Package Compare versions

Comparing version 2.0.2 to 2.1.0

package.json

 {
   "name": "@starship-ci/client",
-  "version": "2.0.2",
+  "version": "2.1.0",
   "author": "Dan Lynch <[e-mail]>",
@@ -58,3 +58,3 @@ "description": "Starship CI Client",
   },
-  "gitHead": "6a7042b2b25936b375869bc305096961117482b8"
+  "gitHead": "1e64be0304a5b3c2a9b67e993b068c41e2895eee"
 }

README.md

@@ -57,8 +57,8 @@ # StarshipJS
 - Add your configs, similar to how it's done [here](https://github.com/osmosis-labs/osmojs/tree/main/packages/osmojs/starship/configs)
-- Add your workflows for github [like this](https://github.com/osmosis-labs/osmojs/blob/main/.github/workflows/e2e-tests.yaml)
-- Add `yarn starship` commands to your package.json scripts [like this](https://github.com/osmosis-labs/osmojs/blob/20d749c8c5a4ec3db374221dabdf185fa18025a3/packages/osmojs/package.json#L34C5-L38C74)
+- Add your workflows for GitHub Actions [like this](https://github.com/osmosis-labs/osmojs/blob/main/.github/workflows/e2e-tests.yaml)
+- Add `yarn starship` commands to your package.json scripts [like this](https://github.com/osmosis-labs/osmojs/blob/c456184666eda55cd6fee5cd09ba6c05c898d55c/packages/osmojs/package.json#L31-L34)
 — Note the jest configurations in the [osmojs package](https://github.com/osmosis-labs/osmojs/tree/main/packages/osmojs)
 
 
-This will allow you to run `yarn starship` to `setup`, `deploy`, `clean` and other `starship` commands:
+This will allow you to run `yarn starship` to `start`, `setup`, `deploy`, `stop` and other `starship` commands:
 
@@ -68,19 +68,6 @@ #### Deploying `Starship` 🚀
 ```sh
-# setup helm/starship
-yarn starship setup
+yarn starship start
 
 # sanity check
 yarn starship get-pods
-
-# deploy starship
-yarn starship deploy
-
-# wait til STATUS=Running
-yarn starship get-pods
-
-# port forwarding
-yarn starship start-ports
-
-# check pids
-yarn starship port-pids
 ```
@@ -101,7 +88,4 @@
 ```sh
-# stop port forwarding (done by clean() too)
-# yarn starship stop-ports
-
-# stop ports and delete & remove helm chart
-yarn starship clean
+# stop ports and delete deployment
+yarn starship stop
 ```
@@ -111,2 +95,26 @@
 
+### Manual setup
+
+Instead of using `yarn starship start`, you can also to each step, and do checks in between:
+
+```sh
+# setup helm/starship
+yarn starship setup
+
+# sanity check
+yarn starship get-pods
+
+# deploy starship
+yarn starship deploy
+
+# wait til STATUS=Running
+yarn starship get-pods
+
+# port forwarding
+yarn starship start-ports
+
+# check pids
+yarn starship port-pids
+```
+
 The `StarshipClient` simplifies managing Kubernetes resources, specifically tailored for developers working in interchain environments. Below is an example showing how to instantiate the client and use it to manage a Helm deployment:
@@ -127,3 +135,3 @@
   helmChart: 'devnet',
-  helmVersion: 'v0.2.1'
+  helmVersion: 'v0.2.3'
 });
@@ -130,0 +138,0 @@ ```

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

54674

increased by0.2%

Number of lines in readme file

213

increased by3.9%

No dependency changes