@starship-ci/client - npm Package Compare versions

Comparing version 0.4.0 to 1.0.0

package.json

 {
   "name": "@starship-ci/client",
-  "version": "0.4.0",
+  "version": "1.0.0",
   "author": "Dan Lynch <[e-mail]>",
@@ -58,3 +58,3 @@ "description": "Starship CI Client",
   },
-  "gitHead": "6fca9dd6d692792b57858399927b9dc3305bb42b"
+  "gitHead": "f274802408d1984d5e2ba23bb260801b0c8db59a"
 }

README.md

@@ -31,3 +31,7 @@ # StarshipJS
 - [Install](#install)
-- [Usage](#usage)
+- [Recommended Usage](#recommended-usage)
+  - [Deploying Starship](#deploying-starship)
+  - [Running End-to-End Tests](#running-end-to-end-tests)
+  - [Teardown](#teardown)
+- [Advanced Usage](#advanced-usage)
   - [Initializing the Client](#initializing-the-client)
@@ -49,4 +53,59 @@ - [Configuration](#configuration)
 
-## Usage 
+### Recommended Usage
 
+Stay tuned for a `create-cosmos-app` boilerplate! For now, this is the most recommended setup. Consider everything else after this section "advanced setup".
+
+- We recommend studying the [osmojs starship integration](https://github.com/osmosis-labs/osmojs/tree/main/packages/osmojs/starship) and replicating it.
+- 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)
+— 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:
+
+#### Deploying `starship`
+
+```sh
+# setup helm/starship
+yarn starship setup
+
+# sanity check
+kubectl get pods --all-namespaces
+
+# deploy starship
+yarn starship deploy
+
+# wait til STATUS=Running
+kubectl get pods
+
+# port forwarding
+yarn starship startPortForward
+
+# check pids
+yarn starship printForwardPids
+```
+
+#### Running End-to-End Tests
+
+```sh
+# test
+yarn starship:test
+
+# watch 
+yarn starship:watch
+```
+
+#### Teardown
+
+```sh
+# stop port forwarding (done by clean() too)
+# yarn starship stopPortForward
+
+# stop ports and delete & remove helm chart
+yarn starship clean
+```
+
+## Advanced Usage 
+
 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:
@@ -53,0 +112,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

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

47571

increased by3.93%

Number of low quality alerts

0

decreased by-100%

Number of lines in readme file

206

increased by40.14%

No dependency changes