shipthis 0.0.30 → 0.0.31

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 (6) hide show
  1. package/README.md +59 -22
  2. package/docs/README.md +59 -22
  3. package/docs/apple/apiKey.md +1 -1
  4. package/docs/game/build.md +2 -2
  5. package/oclif.manifest.json +134 -134
  6. package/package.json +6 -2
package/README.md CHANGED
@@ -1,22 +1,27 @@
1
- # ShipThis CLI
2
-
3
- ## Introduction
4
-
5
- ShipThis is a tool which helps you manage releasing your [Godot](https://godotengine.org/) games to the iOS App Store.
6
-
7
- :::tip Info
8
- You don't need an Apple computer to use ShipThis.
9
- :::
10
-
11
- ## Quickstart
12
-
13
- Let's discover **ShipThis in less than 5 minutes**.
14
-
15
- ### What you'll need
16
-
17
- - A Godot game
18
- - [Node.js](https://nodejs.org/en/download/) version 18.0 or above:
19
- - When installing Node.js, you are recommended to check all checkboxes related to dependencies.
1
+ <h1 align="center">
2
+ <a href="https://shipthis.cc">
3
+ <picture>
4
+ <source height="56" width="260" media="(prefers-color-scheme: dark)" srcset="https://shipthis.cc/logo_darkmode.svg">
5
+ <img height="56" width="260" alt="ShipThis" src="https://shipthis.cc/logo_normal.svg">
6
+ </picture>
7
+ </a>
8
+ <br>
9
+ <a href="https://discord.gg/rHhguPjZ">
10
+ <img src="https://img.shields.io/discord/1304144717239554069?style=flat-square&label=%F0%9F%92%AC%20discord&color=00ACD7">
11
+ </a>
12
+ </h1>
13
+ <p align="center">
14
+ <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>
15
+ </p>
16
+
17
+ ---
18
+
19
+ ## ⚡️ Quickstart
20
+
21
+ ### You will need
22
+
23
+ - A Godot 3.6 or 4.3 game
24
+ - [Node.js](https://nodejs.org/en/download/) version 18.0 or above
20
25
  - An [Apple Developer](https://developer.apple.com) account
21
26
 
22
27
  ### 1. Install ShipThis
@@ -37,7 +42,7 @@ shipthis login
37
42
 
38
43
  ### 3. Configure your game
39
44
 
40
- Set up your ShipThis configuration using the built in [wizard](https://shipthis.cc/docs/wizard):
45
+ 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):
41
46
 
42
47
  ```bash
43
48
  shipthis game wizard
@@ -54,14 +59,46 @@ shipthis game ship
54
59
  Once you are happy with the build you can submit it to Apple using [App Store
55
60
  Connect](https://appstoreconnect.apple.com/).
56
61
 
57
- ## Topics
62
+ 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**.
63
+
64
+ ### Next Steps
65
+
66
+ - Checkout the [ShipThis Tutorial](https://shipthis.cc/docs/tutorial)
67
+
68
+ ## 📖 Command Reference
69
+
70
+ ### Topics
58
71
 
59
72
  - [apple](https://shipthis.cc/docs/reference/apple) - Commands that relate to linking your ShipThis account with your Apple Developer Account
60
73
  - [game](https://shipthis.cc/docs/reference/game) - Commands that relate to configuring the specific game in the current working directory.
61
74
 
62
- ## Commands
75
+ ### Commands
63
76
 
64
77
  - [dashboard](https://shipthis.cc/docs/reference/dashboard) - Opens the web browser to your shipthis.cc dashboard
65
78
  - [login](https://shipthis.cc/docs/reference/login) - Signin or create a new account
66
79
  - [status](https://shipthis.cc/docs/reference/status) - Display your overall ShipThis account status
67
80
  - [help](https://shipthis.cc/docs/reference/help) - Display help for a specific topic or command
81
+
82
+ @octocat :+1: This PR looks great - it's ready to merge! :shipit:
83
+
84
+ > [!NOTE]
85
+ > Highlights information that users should take into account, even when skimming.
86
+
87
+ > [!TIP]
88
+ > Optional information to help a user be more successful.
89
+
90
+ > [!IMPORTANT]
91
+ > Crucial information necessary for users to succeed.
92
+
93
+ > [!WARNING]
94
+ > Critical content demanding immediate user attention due to potential risks.
95
+
96
+ > [!CAUTION]
97
+ > Negative potential consequences of an action.
98
+
99
+ <details>
100
+ <summary>📚 Test</summary>
101
+
102
+ # This is a test
103
+
104
+ </details>
package/docs/README.md CHANGED
@@ -1,22 +1,27 @@
1
- # ShipThis CLI
2
-
3
- ## Introduction
4
-
5
- ShipThis is a tool which helps you manage releasing your [Godot](https://godotengine.org/) games to the iOS App Store.
6
-
7
- :::tip Info
8
- You don't need an Apple computer to use ShipThis.
9
- :::
10
-
11
- ## Quickstart
12
-
13
- Let's discover **ShipThis in less than 5 minutes**.
14
-
15
- ### What you'll need
16
-
17
- - A Godot game
18
- - [Node.js](https://nodejs.org/en/download/) version 18.0 or above:
19
- - When installing Node.js, you are recommended to check all checkboxes related to dependencies.
1
+ <h1 align="center">
2
+ <a href="https://shipthis.cc">
3
+ <picture>
4
+ <source height="56" width="260" media="(prefers-color-scheme: dark)" srcset="https://shipthis.cc/logo_darkmode.svg">
5
+ <img height="56" width="260" alt="ShipThis" src="https://shipthis.cc/logo_normal.svg">
6
+ </picture>
7
+ </a>
8
+ <br>
9
+ <a href="https://discord.gg/rHhguPjZ">
10
+ <img src="https://img.shields.io/discord/1304144717239554069?style=flat-square&label=%F0%9F%92%AC%20discord&color=00ACD7">
11
+ </a>
12
+ </h1>
13
+ <p align="center">
14
+ <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>
15
+ </p>
16
+
17
+ ---
18
+
19
+ ## ⚡️ Quickstart
20
+
21
+ ### You will need
22
+
23
+ - A Godot 3.6 or 4.3 game
24
+ - [Node.js](https://nodejs.org/en/download/) version 18.0 or above
20
25
  - An [Apple Developer](https://developer.apple.com) account
21
26
 
22
27
  ### 1. Install ShipThis
@@ -37,7 +42,7 @@ shipthis login
37
42
 
38
43
  ### 3. Configure your game
39
44
 
40
- Set up your ShipThis configuration using the built in [wizard](https://shipthis.cc/docs/wizard):
45
+ 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):
41
46
 
42
47
  ```bash
43
48
  shipthis game wizard
@@ -54,15 +59,47 @@ shipthis game ship
54
59
  Once you are happy with the build you can submit it to Apple using [App Store
55
60
  Connect](https://appstoreconnect.apple.com/).
56
61
 
62
+ 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**.
63
+
64
+ ### Next Steps
65
+
66
+ - Checkout the [ShipThis Tutorial](https://shipthis.cc/docs/tutorial)
67
+
68
+ ## 📖 Command Reference
57
69
 
58
- ## Topics
70
+ ### Topics
59
71
 
60
72
  - [apple](https://shipthis.cc/docs/reference/apple) - Commands that relate to linking your ShipThis account with your Apple Developer Account
61
73
  - [game](https://shipthis.cc/docs/reference/game) - Commands that relate to configuring the specific game in the current working directory.
62
74
 
63
- ## Commands
75
+ ### Commands
64
76
 
65
77
  - [dashboard](https://shipthis.cc/docs/reference/dashboard) - Opens the web browser to your shipthis.cc dashboard
66
78
  - [login](https://shipthis.cc/docs/reference/login) - Signin or create a new account
67
79
  - [status](https://shipthis.cc/docs/reference/status) - Display your overall ShipThis account status
68
80
  - [help](https://shipthis.cc/docs/reference/help) - Display help for a specific topic or command
81
+
82
+ @octocat :+1: This PR looks great - it's ready to merge! :shipit:
83
+
84
+
85
+ > [!NOTE]
86
+ > Highlights information that users should take into account, even when skimming.
87
+
88
+ > [!TIP]
89
+ > Optional information to help a user be more successful.
90
+
91
+ > [!IMPORTANT]
92
+ > Crucial information necessary for users to succeed.
93
+
94
+ > [!WARNING]
95
+ > Critical content demanding immediate user attention due to potential risks.
96
+
97
+ > [!CAUTION]
98
+ > Negative potential consequences of an action.
99
+
100
+ <details>
101
+ <summary>📚 Test</summary>
102
+
103
+ # This is a test
104
+
105
+ </details>
package/docs/apple/apiKey.md CHANGED
@@ -5,7 +5,7 @@
5
5
  Commands in the apple apiKey topic are prefixed `shipthis apple apiKey`. These commands relate to App Store Connect API Keys.
6
6
 
7
7
  - You can view the App Store Connect API Keys in the [Apple Developer Portal](https://appstoreconnect.apple.com/access/integrations/api).
8
- - You can view the keys which ShipThis can use in the [ShipThis Dashboard](https://shipthis.cc/credentials)
8
+ - You can view the keys which ShipThis can use in the [ShipThis Dashboard](https://shipthis.cc/credentials).
9
9
 
10
10
  :::info
11
11
  An **App Store Connect API key** is used to authenticate and authorize automated interactions with Apple's App Store Connect API, enabling tasks like managing app metadata, TestFlight, and sales reports.
package/docs/game/build.md CHANGED
@@ -17,7 +17,7 @@ your game code. It should not be confused with the command [`shipthis game ship`
17
17
 
18
18
  ## Commands
19
19
 
20
- ### Command: `game build download`
20
+ ### `game build download`
21
21
 
22
22
  #### Description
23
23
 
@@ -46,7 +46,7 @@ EXAMPLES
46
46
  $ shipthis game build download --gameId 0c179fc4 e4b9a3d7 output.apk
47
47
  ```
48
48
 
49
- ### Command: `game build list`
49
+ ### `game build list`
50
50
 
51
51
  #### Description
52
52
 
package/oclif.manifest.json CHANGED
@@ -663,6 +663,139 @@
663
663
  "status.js"
664
664
  ]
665
665
  },
666
+ "game:build:download": {
667
+ "aliases": [],
668
+ "args": {
669
+ "build_id": {
670
+ "description": "The ID of the build to download",
671
+ "name": "build_id",
672
+ "required": true
673
+ },
674
+ "file": {
675
+ "description": "Name of the file to output",
676
+ "name": "file",
677
+ "required": true
678
+ }
679
+ },
680
+ "description": "Downloads the given build artifact to the specified file",
681
+ "examples": [
682
+ "<%= config.bin %> <%= command.id %> 7a3f5c92 output.ipa",
683
+ "<%= config.bin %> <%= command.id %> --gameId 0c179fc4 e4b9a3d7 output.apk"
684
+ ],
685
+ "flags": {
686
+ "gameId": {
687
+ "char": "g",
688
+ "description": "The ID of the game",
689
+ "name": "gameId",
690
+ "hasDynamicHelp": false,
691
+ "multiple": false,
692
+ "type": "option"
693
+ },
694
+ "force": {
695
+ "char": "f",
696
+ "description": "Overwrite the file if it already exists",
697
+ "name": "force",
698
+ "allowNo": false,
699
+ "type": "boolean"
700
+ }
701
+ },
702
+ "hasDynamicHelp": false,
703
+ "hiddenAliases": [],
704
+ "id": "game:build:download",
705
+ "pluginAlias": "shipthis",
706
+ "pluginName": "shipthis",
707
+ "pluginType": "core",
708
+ "strict": true,
709
+ "enableJsonFlag": false,
710
+ "isESM": true,
711
+ "relativePath": [
712
+ "dist",
713
+ "commands",
714
+ "game",
715
+ "build",
716
+ "download.js"
717
+ ]
718
+ },
719
+ "game:build:list": {
720
+ "aliases": [],
721
+ "args": {},
722
+ "description": "Lists the builds for successful jobs of a game.",
723
+ "examples": [
724
+ "<%= config.bin %> <%= command.id %>",
725
+ "<%= config.bin %> <%= command.id %> --gameId 0c179fc4",
726
+ "<%= config.bin %> <%= command.id %> --gameId 0c179fc4 --pageSize 20 --pageNumber 1"
727
+ ],
728
+ "flags": {
729
+ "gameId": {
730
+ "char": "g",
731
+ "description": "The ID of the game",
732
+ "name": "gameId",
733
+ "hasDynamicHelp": false,
734
+ "multiple": false,
735
+ "type": "option"
736
+ },
737
+ "pageNumber": {
738
+ "char": "p",
739
+ "description": "The page number to show (starts at 0)",
740
+ "name": "pageNumber",
741
+ "default": 0,
742
+ "hasDynamicHelp": false,
743
+ "multiple": false,
744
+ "type": "option"
745
+ },
746
+ "pageSize": {
747
+ "char": "s",
748
+ "description": "The number of items to show per page",
749
+ "name": "pageSize",
750
+ "default": 10,
751
+ "hasDynamicHelp": false,
752
+ "multiple": false,
753
+ "type": "option"
754
+ },
755
+ "orderBy": {
756
+ "char": "o",
757
+ "description": "The field to order by",
758
+ "name": "orderBy",
759
+ "default": "createdAt",
760
+ "hasDynamicHelp": false,
761
+ "multiple": false,
762
+ "options": [
763
+ "createdAt",
764
+ "updatedAt"
765
+ ],
766
+ "type": "option"
767
+ },
768
+ "order": {
769
+ "char": "r",
770
+ "description": "The order to sort by",
771
+ "name": "order",
772
+ "default": "desc",
773
+ "hasDynamicHelp": false,
774
+ "multiple": false,
775
+ "options": [
776
+ "asc",
777
+ "desc"
778
+ ],
779
+ "type": "option"
780
+ }
781
+ },
782
+ "hasDynamicHelp": false,
783
+ "hiddenAliases": [],
784
+ "id": "game:build:list",
785
+ "pluginAlias": "shipthis",
786
+ "pluginName": "shipthis",
787
+ "pluginType": "core",
788
+ "strict": true,
789
+ "enableJsonFlag": false,
790
+ "isESM": true,
791
+ "relativePath": [
792
+ "dist",
793
+ "commands",
794
+ "game",
795
+ "build",
796
+ "list.js"
797
+ ]
798
+ },
666
799
  "apple:apiKey:create": {
667
800
  "aliases": [],
668
801
  "args": {},
@@ -812,139 +945,6 @@
812
945
  "status.js"
813
946
  ]
814
947
  },
815
- "game:build:download": {
816
- "aliases": [],
817
- "args": {
818
- "build_id": {
819
- "description": "The ID of the build to download",
820
- "name": "build_id",
821
- "required": true
822
- },
823
- "file": {
824
- "description": "Name of the file to output",
825
- "name": "file",
826
- "required": true
827
- }
828
- },
829
- "description": "Downloads the given build artifact to the specified file",
830
- "examples": [
831
- "<%= config.bin %> <%= command.id %> 7a3f5c92 output.ipa",
832
- "<%= config.bin %> <%= command.id %> --gameId 0c179fc4 e4b9a3d7 output.apk"
833
- ],
834
- "flags": {
835
- "gameId": {
836
- "char": "g",
837
- "description": "The ID of the game",
838
- "name": "gameId",
839
- "hasDynamicHelp": false,
840
- "multiple": false,
841
- "type": "option"
842
- },
843
- "force": {
844
- "char": "f",
845
- "description": "Overwrite the file if it already exists",
846
- "name": "force",
847
- "allowNo": false,
848
- "type": "boolean"
849
- }
850
- },
851
- "hasDynamicHelp": false,
852
- "hiddenAliases": [],
853
- "id": "game:build:download",
854
- "pluginAlias": "shipthis",
855
- "pluginName": "shipthis",
856
- "pluginType": "core",
857
- "strict": true,
858
- "enableJsonFlag": false,
859
- "isESM": true,
860
- "relativePath": [
861
- "dist",
862
- "commands",
863
- "game",
864
- "build",
865
- "download.js"
866
- ]
867
- },
868
- "game:build:list": {
869
- "aliases": [],
870
- "args": {},
871
- "description": "Lists the builds for successful jobs of a game.",
872
- "examples": [
873
- "<%= config.bin %> <%= command.id %>",
874
- "<%= config.bin %> <%= command.id %> --gameId 0c179fc4",
875
- "<%= config.bin %> <%= command.id %> --gameId 0c179fc4 --pageSize 20 --pageNumber 1"
876
- ],
877
- "flags": {
878
- "gameId": {
879
- "char": "g",
880
- "description": "The ID of the game",
881
- "name": "gameId",
882
- "hasDynamicHelp": false,
883
- "multiple": false,
884
- "type": "option"
885
- },
886
- "pageNumber": {
887
- "char": "p",
888
- "description": "The page number to show (starts at 0)",
889
- "name": "pageNumber",
890
- "default": 0,
891
- "hasDynamicHelp": false,
892
- "multiple": false,
893
- "type": "option"
894
- },
895
- "pageSize": {
896
- "char": "s",
897
- "description": "The number of items to show per page",
898
- "name": "pageSize",
899
- "default": 10,
900
- "hasDynamicHelp": false,
901
- "multiple": false,
902
- "type": "option"
903
- },
904
- "orderBy": {
905
- "char": "o",
906
- "description": "The field to order by",
907
- "name": "orderBy",
908
- "default": "createdAt",
909
- "hasDynamicHelp": false,
910
- "multiple": false,
911
- "options": [
912
- "createdAt",
913
- "updatedAt"
914
- ],
915
- "type": "option"
916
- },
917
- "order": {
918
- "char": "r",
919
- "description": "The order to sort by",
920
- "name": "order",
921
- "default": "desc",
922
- "hasDynamicHelp": false,
923
- "multiple": false,
924
- "options": [
925
- "asc",
926
- "desc"
927
- ],
928
- "type": "option"
929
- }
930
- },
931
- "hasDynamicHelp": false,
932
- "hiddenAliases": [],
933
- "id": "game:build:list",
934
- "pluginAlias": "shipthis",
935
- "pluginName": "shipthis",
936
- "pluginType": "core",
937
- "strict": true,
938
- "enableJsonFlag": false,
939
- "isESM": true,
940
- "relativePath": [
941
- "dist",
942
- "commands",
943
- "game",
944
- "build",
945
- "list.js"
946
- ]
947
- },
948
948
  "game:ios:status": {
949
949
  "aliases": [],
950
950
  "args": {},
@@ -1508,5 +1508,5 @@
1508
1508
  ]
1509
1509
  }
1510
1510
  },
1511
- "version": "0.0.30"
1511
+ "version": "0.0.31"
1512
1512
  }
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "shipthis",
3
3
  "description": "Game Shipping Tool",
4
- "version": "0.0.30",
4
+ "version": "0.0.31",
5
5
  "author": "Hello Invent Ltd",
6
6
  "bin": {
7
7
  "shipthis": "./bin/run.js"
@@ -80,7 +80,11 @@
80
80
  ],
81
81
  "homepage": "https://shipthis.cc",
82
82
  "keywords": [
83
- "oclif"
83
+ "godot",
84
+ "apple",
85
+ "ios",
86
+ "mobile",
87
+ "game"
84
88
  ],
85
89
  "license": "MIT",
86
90
  "main": "dist/index.js",