npm - shipthis - Versions diffs - 0.0.31 → 0.0.32 - Mend

shipthis 0.0.31 → 0.0.32

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (4) hide show

package/README.md CHANGED Viewed

@@ -1,8 +1,8 @@
 <h1 align="center">
   <a href="https://shipthis.cc">
     <picture>
-      <source height="56" width="260" media="(prefers-color-scheme: dark)" srcset="https://shipthis.cc/logo_darkmode.svg">
-      <img height="56" width="260" alt="ShipThis" src="https://shipthis.cc/logo_normal.svg">
+    <source height="56" width="260" srcset="https://shipthis.cc/logo_darkmode.svg">
+      <img height="56" width="260" alt="ShipThis" src="https://shipthis.cc/logo_darkmode.svg" ></img>
     </picture>
   </a>
   <br>
@@ -78,27 +78,3 @@ Re-run the `shipthis game ship` command each time you want to build a new releas
 - [login](https://shipthis.cc/docs/reference/login) - Signin or create a new account
 - [status](https://shipthis.cc/docs/reference/status) - Display your overall ShipThis account status
 - [help](https://shipthis.cc/docs/reference/help) - Display help for a specific topic or command
-@octocat :+1: This PR looks great - it's ready to merge! :shipit:
-> [!NOTE]
-> Highlights information that users should take into account, even when skimming.
-> [!TIP]
-> Optional information to help a user be more successful.
-> [!IMPORTANT]
-> Crucial information necessary for users to succeed.
-> [!WARNING]
-> Critical content demanding immediate user attention due to potential risks.
-> [!CAUTION]
-> Negative potential consequences of an action.
-<details>
-  <summary>📚 Test</summary>
-# This is a test
-</details>

package/docs/README.md CHANGED Viewed

@@ -1,105 +1,19 @@
-<h1 align="center">
-  <a href="https://shipthis.cc">
-    <picture>
-      <source height="56" width="260" media="(prefers-color-scheme: dark)" srcset="https://shipthis.cc/logo_darkmode.svg">
-      <img height="56" width="260" alt="ShipThis" src="https://shipthis.cc/logo_normal.svg">
-    </picture>
-  </a>
-  <br>
-  <a href="https://discord.gg/rHhguPjZ">
-    <img src="https://img.shields.io/discord/1304144717239554069?style=flat-square&label=%F0%9F%92%AC%20discord&color=00ACD7">
-  </a>
-</h1>
-<p align="center">
-  <em><b>ShipThis</b> is a <b>command line tool</b> which manages releasing your <a href="https://godotengine.org/">Godot</a> games to the <b>iOS App Store</b>. Designed to compile and upload your Godot games in the cloud, meaning <b>you do not need to install or run Xcode to release an iOS game</b>.</em>
-</p>
+# ShipThis CLI Reference
----
+**ShipThis** is a **command-line tool** which manages releasing your [Godot](https://godotengine.org/) games to the **iOS App Store**.
-## ⚡️ Quickstart
+:::tip New to ShipThis?
+Begin with our [Quickstart Guide](/docs/quickstart).
+:::
-### You will need
-- A Godot 3.6 or 4.3 game
-- [Node.js](https://nodejs.org/en/download/) version 18.0 or above
-- An [Apple Developer](https://developer.apple.com) account
-### 1. Install ShipThis
-ShipThis can be installed as a package via the [NPM package manager](https://www.npmjs.com/). Run the following at the command line:
-```bash
-npm install -g shipthis
-```
-### 2. Create an account
-Set up an account with ShipThis by logging in for the first time using the [`shipthis login`](https://shipthis.cc/docs/reference/login) command.
-```bash
-shipthis login
-```
-### 3. Configure your game
-Set up your ShipThis configuration using the built in [wizard](https://shipthis.cc/docs/wizard). Run this command from within a Godot game directory (with a project.godot file):
-```bash
-shipthis game wizard
-```
-### 4. Ship
-Now you can publish your game to TestFlight with the [`shipthis game ship`](https://shipthis.cc/docs/reference/game/ship) command:
-```bash
-shipthis game ship
-```
-Once you are happy with the build you can submit it to Apple using [App Store
-Connect](https://appstoreconnect.apple.com/).
-Re-run the `shipthis game ship` command each time you want to build a new release of your game. **You never need to run Xcode**.
-### Next Steps
-- Checkout the [ShipThis Tutorial](https://shipthis.cc/docs/tutorial)
-## 📖 Command Reference
-### Topics
+## Topics
 - [apple](https://shipthis.cc/docs/reference/apple) - Commands that relate to linking your ShipThis account with your Apple Developer Account
 - [game](https://shipthis.cc/docs/reference/game) - Commands that relate to configuring the specific game in the current working directory.
-### Commands
+## Commands
 - [dashboard](https://shipthis.cc/docs/reference/dashboard) - Opens the web browser to your shipthis.cc dashboard
 - [login](https://shipthis.cc/docs/reference/login) - Signin or create a new account
 - [status](https://shipthis.cc/docs/reference/status) - Display your overall ShipThis account status
 - [help](https://shipthis.cc/docs/reference/help) - Display help for a specific topic or command
-@octocat :+1: This PR looks great - it's ready to merge! :shipit:
-> [!NOTE]
-> Highlights information that users should take into account, even when skimming.
-> [!TIP]
-> Optional information to help a user be more successful.
-> [!IMPORTANT]
-> Crucial information necessary for users to succeed.
-> [!WARNING]
-> Critical content demanding immediate user attention due to potential risks.
-> [!CAUTION]
-> Negative potential consequences of an action.
-<details>
-  <summary>📚 Test</summary>
-# This is a test
-</details>

package/oclif.manifest.json CHANGED Viewed

@@ -514,6 +514,155 @@
         "wizard.js"
       ]
     },
+    "apple:apiKey:create": {
+      "aliases": [],
+      "args": {},
+      "description": "Creates an App Store Connect API Key in your Apple Developer account.\nSaves the private key in your ShipThis account.",
+      "examples": [
+        "<%= config.bin %> <%= command.id %>",
+        "<%= config.bin %> <%= command.id %> --force"
+      ],
+      "flags": {
+        "force": {
+          "char": "f",
+          "name": "force",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "quiet": {
+          "char": "q",
+          "description": "Avoid output except for interactions and errors",
+          "name": "quiet",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "apple:apiKey:create",
+      "pluginAlias": "shipthis",
+      "pluginName": "shipthis",
+      "pluginType": "core",
+      "strict": true,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "apple",
+        "apiKey",
+        "create.js"
+      ]
+    },
+    "apple:apiKey:export": {
+      "aliases": [],
+      "args": {
+        "file": {
+          "description": "Name of the ZIP file to create",
+          "name": "file",
+          "required": true
+        }
+      },
+      "description": "Saves the current App Store Connect API Key to a ZIP file",
+      "examples": [
+        "<%= config.bin %> <%= command.id %> userApiKey.zip"
+      ],
+      "flags": {
+        "force": {
+          "char": "f",
+          "description": "Overwrite the file if it already exists",
+          "name": "force",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "apple:apiKey:export",
+      "pluginAlias": "shipthis",
+      "pluginName": "shipthis",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "apple",
+        "apiKey",
+        "export.js"
+      ]
+    },
+    "apple:apiKey:import": {
+      "aliases": [],
+      "args": {
+        "file": {
+          "description": "Name of the ZIP file to import (must be in the same format as the export)",
+          "name": "file",
+          "required": true
+        }
+      },
+      "description": "Imports an App Store Connect API Key ZIP file into your ShipThis account",
+      "examples": [
+        "<%= config.bin %> <%= command.id %> userApiKey.zip"
+      ],
+      "flags": {
+        "force": {
+          "char": "f",
+          "name": "force",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "apple:apiKey:import",
+      "pluginAlias": "shipthis",
+      "pluginName": "shipthis",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "apple",
+        "apiKey",
+        "import.js"
+      ]
+    },
+    "apple:apiKey:status": {
+      "aliases": [],
+      "args": {},
+      "description": "Displays the status of App Store Connect API Keys in your Apple and ShipThis accounts.\nThis API key is used to automatically publish your games to the App Store.",
+      "examples": [
+        "<%= config.bin %> <%= command.id %>",
+        "<%= config.bin %> <%= command.id %> --noAppleAuth"
+      ],
+      "flags": {
+        "noAppleAuth": {
+          "char": "f",
+          "name": "noAppleAuth",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "apple:apiKey:status",
+      "pluginAlias": "shipthis",
+      "pluginName": "shipthis",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "apple",
+        "apiKey",
+        "status.js"
+      ]
+    },
     "apple:certificate:create": {
       "aliases": [],
       "args": {},
@@ -796,155 +945,6 @@
         "list.js"
       ]
     },
-    "apple:apiKey:create": {
-      "aliases": [],
-      "args": {},
-      "description": "Creates an App Store Connect API Key in your Apple Developer account.\nSaves the private key in your ShipThis account.",
-      "examples": [
-        "<%= config.bin %> <%= command.id %>",
-        "<%= config.bin %> <%= command.id %> --force"
-      ],
-      "flags": {
-        "force": {
-          "char": "f",
-          "name": "force",
-          "allowNo": false,
-          "type": "boolean"
-        },
-        "quiet": {
-          "char": "q",
-          "description": "Avoid output except for interactions and errors",
-          "name": "quiet",
-          "allowNo": false,
-          "type": "boolean"
-        }
-      },
-      "hasDynamicHelp": false,
-      "hiddenAliases": [],
-      "id": "apple:apiKey:create",
-      "pluginAlias": "shipthis",
-      "pluginName": "shipthis",
-      "pluginType": "core",
-      "strict": true,
-      "isESM": true,
-      "relativePath": [
-        "dist",
-        "commands",
-        "apple",
-        "apiKey",
-        "create.js"
-      ]
-    },
-    "apple:apiKey:export": {
-      "aliases": [],
-      "args": {
-        "file": {
-          "description": "Name of the ZIP file to create",
-          "name": "file",
-          "required": true
-        }
-      },
-      "description": "Saves the current App Store Connect API Key to a ZIP file",
-      "examples": [
-        "<%= config.bin %> <%= command.id %> userApiKey.zip"
-      ],
-      "flags": {
-        "force": {
-          "char": "f",
-          "description": "Overwrite the file if it already exists",
-          "name": "force",
-          "allowNo": false,
-          "type": "boolean"
-        }
-      },
-      "hasDynamicHelp": false,
-      "hiddenAliases": [],
-      "id": "apple:apiKey:export",
-      "pluginAlias": "shipthis",
-      "pluginName": "shipthis",
-      "pluginType": "core",
-      "strict": true,
-      "enableJsonFlag": false,
-      "isESM": true,
-      "relativePath": [
-        "dist",
-        "commands",
-        "apple",
-        "apiKey",
-        "export.js"
-      ]
-    },
-    "apple:apiKey:import": {
-      "aliases": [],
-      "args": {
-        "file": {
-          "description": "Name of the ZIP file to import (must be in the same format as the export)",
-          "name": "file",
-          "required": true
-        }
-      },
-      "description": "Imports an App Store Connect API Key ZIP file into your ShipThis account",
-      "examples": [
-        "<%= config.bin %> <%= command.id %> userApiKey.zip"
-      ],
-      "flags": {
-        "force": {
-          "char": "f",
-          "name": "force",
-          "allowNo": false,
-          "type": "boolean"
-        }
-      },
-      "hasDynamicHelp": false,
-      "hiddenAliases": [],
-      "id": "apple:apiKey:import",
-      "pluginAlias": "shipthis",
-      "pluginName": "shipthis",
-      "pluginType": "core",
-      "strict": true,
-      "enableJsonFlag": false,
-      "isESM": true,
-      "relativePath": [
-        "dist",
-        "commands",
-        "apple",
-        "apiKey",
-        "import.js"
-      ]
-    },
-    "apple:apiKey:status": {
-      "aliases": [],
-      "args": {},
-      "description": "Displays the status of App Store Connect API Keys in your Apple and ShipThis accounts.\nThis API key is used to automatically publish your games to the App Store.",
-      "examples": [
-        "<%= config.bin %> <%= command.id %>",
-        "<%= config.bin %> <%= command.id %> --noAppleAuth"
-      ],
-      "flags": {
-        "noAppleAuth": {
-          "char": "f",
-          "name": "noAppleAuth",
-          "allowNo": false,
-          "type": "boolean"
-        }
-      },
-      "hasDynamicHelp": false,
-      "hiddenAliases": [],
-      "id": "apple:apiKey:status",
-      "pluginAlias": "shipthis",
-      "pluginName": "shipthis",
-      "pluginType": "core",
-      "strict": true,
-      "enableJsonFlag": false,
-      "isESM": true,
-      "relativePath": [
-        "dist",
-        "commands",
-        "apple",
-        "apiKey",
-        "status.js"
-      ]
-    },
     "game:ios:status": {
       "aliases": [],
       "args": {},
@@ -1508,5 +1508,5 @@
       ]
     }
   },
-  "version": "0.0.31"
+  "version": "0.0.32"
 }

package/package.json CHANGED Viewed

@@ -1,7 +1,7 @@
 {
   "name": "shipthis",
   "description": "Game Shipping Tool",
-  "version": "0.0.31",
+  "version": "0.0.32",
   "author": "Hello Invent Ltd",
   "bin": {
     "shipthis": "./bin/run.js"