Merge pull request #621 from hyperweb-io/anmol/doc-versions

docs: version and compatibility
hyperweb-io · Feb 17, 2025 · f0b53fd · f0b53fd
2 parents 7425ad0 + 74dd772
commit f0b53fd
Show file tree

Hide file tree

Showing 2 changed files with 41 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -80,6 +80,26 @@ registry:
 
 For more details on the configuration options and directives available, refer to the [Starship Config](https://docs.cosmology.zone/starship/config).
 
+## Versions & Compatibility
+
+### Current Versions
+| Component	           | Version | Link                                                                                |
+|------------------------|---------|-------------------------------------------------------------------------------------|
+| Helm Chart             | 	1.2.0  | 	-                                                                                  |
+| Starship NPM CLI       | 	3.2.0  | [NPM](https://www.npmjs.com/package/@starship-ci/client/v/3.2.0)                |
+| NPM Client             | 3.2.0 | [NPM](https://www.npmjs.com/package/@starship-ci/cli/v/3.2.0)                       |
+| NPM StarshipJS         | 	3.0.0 | 	[NPM](https://www.npmjs.com/package/starshipjs/v/3.0.0)                            |
+| Starship GitHub Action |	0.5.8 | 	[Github Action](https://github.com/hyperweb-io/starship-action/releases/tag/0.5.8) |
+
+### Compatibility Matrix
+| Starship Version | 	Helm Chart         | 	NPM CLI    | 	NPM Client | 	StarshipJS | 	GitHub Action |
+|------------------|---------------------|-------------|-------------|-------------|----------------|
+| 1.2.0 | 	✅ 1.2.0 | 	✅ 3.2.0 | 	✅ 3.2.0    | 	✅ 3.0.0    | 	✅ 0.5.8       |
+| 1.1.0 |	✅ 1.1.0 |	✅ 3.1.0 | 	✅ 3.1.0    | 	✅ 3.0.0    | 	✅ 0.5.6       |
+| 1.0.0 |	✅ 1.0.0 |	✅ 3.0.0 | 	✅ 3.0.0    | 	✅ 3.0.0    | 	✅ 0.5.5       | 
+
+> Note: Starship version 1.2.0+ requires Helm 1.2.0+ and NPM CLI 3.2.0+ for full functionality.
+
 ## Running Starship
 
 ### Deploying 🚀

diff --git a/docs/pages/index.mdx b/docs/pages/index.mdx
@@ -112,6 +112,27 @@ registry:
 
 For more details on the configuration options and directives available, refer to the [Starship Config](https://docs.cosmology.zone/starship/config).
 
+### Versions & Compatibility
+
+#### Current Versions
+| Component	           | Version | Link                                                                                |
+|------------------------|---------|-------------------------------------------------------------------------------------|
+| Helm Chart             | 	1.2.0  | 	-                                                                                  |
+| Starship NPM CLI       | 	3.2.0  | [NPM](https://www.npmjs.com/package/@starship-ci/client/v/3.2.0)                |
+| NPM Client             | 3.2.0 | [NPM](https://www.npmjs.com/package/@starship-ci/cli/v/3.2.0)                       |
+| NPM StarshipJS         | 	3.0.0 | 	[NPM](https://www.npmjs.com/package/starshipjs/v/3.0.0)                            |
+| Starship GitHub Action |	0.5.8 | 	[Github Action](https://github.com/hyperweb-io/starship-action/releases/tag/0.5.8) |
+
+
+#### Compatibility Matrix
+| Starship Version | 	Helm Chart         | 	NPM CLI    | 	NPM Client | 	StarshipJS | 	GitHub Action |
+|------------------|---------------------|-------------|-------------|-------------|----------------|
+| 1.2.0 | 	✅ 1.2.0 | 	✅ 3.2.0 | 	✅ 3.2.0    | 	✅ 3.0.0    | 	✅ 0.5.8       |
+| 1.1.0 |	✅ 1.1.0 |	✅ 3.1.0 | 	✅ 3.1.0    | 	✅ 3.0.0    | 	✅ 0.5.6       |
+| 1.0.0 |	✅ 1.0.0 |	✅ 3.0.0 | 	✅ 3.0.0    | 	✅ 3.0.0    | 	✅ 0.5.5       |
+
+> Note: Starship version 1.2.0+ requires Helm 1.2.0+ and NPM CLI 3.2.0+ for full functionality.
+
 ### Running Starship
 
 #### Deploying 🚀