expo-release-it 0.3.2 → 0.5.0

package/README.md

@@ -4,6 +4,10 @@
 
 Opinionated Expo CICD workflow CLI for building & uploading & submitting Expo projects on your machine
 
+# Documentation
+
+Visit our [Documentation Site](https://expo-release-it.mjstudio.net)
+
 # Features
 
 - 🎉 No **EAS**
@@ -12,304 +16,7 @@ Opinionated Expo CICD workflow CLI for building & uploading & submitting Expo pr
 - 🌍 Works with [Expo CNG](https://docs.expo.dev/workflow/continuous-native-generation/) mode (also available in non-CNG environments)
 - 📦 Build artifacts **locally** (`apk`, `aab`, `ipa`)
 - 🚀 Upload artifacts to Google Play Console Internal Testing Track and iOS TestFlight
-- ✅ Submit releases for review
-
-# Why?
-
-**You don't need Expo EAS and to understand how it works in most small projects and our machine is much faster than using the cloud.**
-
-<details>
-  <summary>Full Details</summary>
-
-Expo EAS is convenient, but it requires additional configuration files, console setup, and a conceptual understanding of Over-The-Air (OTA) updates. Also, builds must be performed on EAS Cloud, which is not free and can be slow.
-
-While EAS is useful for larger teams, if you are developing alone or with just a few people and question the need for such a process, `expo-release-it` is the answer.
-
-Based on years of experience developing with React Native, I encourage a more traditional approach: build APK, AAB, and IPA files locally, upload them to each platform’s store testing track, and request reviews—without worrying about binary versions, OTA update versions, or branch management.
-
-This approach is much faster, simpler, and, most importantly, allows you to take full advantage of your computer’s fast CPU.
-
-OTA updates are a powerful tool in React Native, but to fully take advantage of them, you need a self-hosted CDN server, a version management console both in the cloud and inside the app, and you have to separately manage binary versions and bundle versions—all of which introduce significant complexity and semantic overhead that often outweigh the benefits of implementing OTA updates. Furthermore, due to a general lack of deep understanding about OTA updates, issues like native library version mismatches can occur frequently, so OTA updates are excluded by default.
-
-I’m also a big fan of OTA updates, and I’ve enjoyed a lot of efficiency when working in larger teams, but it always required setting up many supporting systems in advance.
-
-`expo-release-it` is a CLI tool that encapsulates the know-how I have gained over years of automating build and review processes.  
-Internally, it ports and integrates tools like Fastlane and Match to automate native binary builds and review requests.
-
-Therefore, this tool enforces an opinionated versioning, build, and review request workflow.  
-However, once you understand this approach, your app deployment process will become significantly faster.
-
-</details>
-
-# Structurual Requirements
-
-- `Version Code(Android)` and `Builder Number(iOS)` are the same.
-- All Keys, Credentials(except iOS certificates & provisioning profiles served in Github separately) are stored in VCS
-
-# Getting Started
-
-## 1. Ruby, Bundler
-
-`expo-release-it` requires `bundler` of ruby is available in your environment to run `Fastlane` internally.
-
-If not, set up your environment so that `ruby` and `bundler` are available by following [Ruby Install Guide](https://www.ruby-lang.org/en/downloads/) 
-
-## 2. Prepare Keys & Credentials
-
-`init` command generates sample key files structure in `expo-release-it/key`. They are **noob files** and you must replace file contents.
-
-> [!IMPORTANT]
-**You must prepare all required key files in `expo-release-it/key` exactly the same filenames.**
-
-### `android_play_console_service_account.json`
-
-Google Play Console actions require authentication using Google Service Account.
-
-You can issue new Google Play Service Account by following Guide
-and prepare `json` file.
-
-- [Fastlane Supply JSON Key Setup Guide](https://docs.fastlane.tools/actions/supply/#setup)
-- [How to Get Your Google Play JSON Key](https://help.radio.co/en/articles/6232140-how-to-get-your-google-play-json-key)
-
-### `android_release.keystore`
-
-Prepare your android release keystore file for **uploading** and **signing** Android build artifacts.
-
-Additional passwords, alias will be prompted during the `init` command and be stored in `keyholder.json`.
-
-- [Keystore generation with Android Studio](https://developer.android.com/studio/publish/app-signing.html#generate-key)
-- [Keystore generation with CLI](https://gist.github.com/henriquemenezes/70feb8fff20a19a65346e48786bedb8f)
-
-### `ios_app_store_connect_api_key`
-
-App Store Connect actions require authentication using App Store Connect Api Key(.p8) 
-
-Additional `issuer_id`, `key_id` values will be prompted during the `init` command and be stored in `keyholder.json`
-
-- [Guide](https://www.revenuecat.com/docs/service-credentials/itunesconnect-app-specific-shared-secret/app-store-connect-api-key-configuration)
-- [Apple Docs Guide](https://developer.apple.com/documentation/appstoreconnectapi/creating-api-keys-for-app-store-connect-api)
-
-## 3. Create & Configure app on the stores as much as possible
-
-Create and configure your application in Google Play Console & App Store Connect as many as possible.
-
-You'd have to fill your key & credentials information using `init` command and pull store metadatas using `pull` command later.
-
-You would need to upload & publish your first artifact, release manually at first.
-
-## 4. Set binary version in expo config file.
-
-The following buildNumber, versionCode format `ABBBCCC` is not mandatory but recommended for readability. 
-
-If your expo config file is `app.json`, then set like the following.
-
-```json
-{
-  "expo": {
-    "version": "1.2.3",
-    "ios": {
-      "buildNumber": "1002003"
-    },
-    "android": {
-      "versionCode": 1002003
-    }
-  }
-}
-
-```
-
-If your expo config file is `app.config.(js|ts|mjs|cjs)`, then set like the following.
-
-```typescript
-import type { ExpoConfig, ConfigContext } from 'expo/config';
-const VERSION_NAME = '1.2.3'; // VERSION_NAME variable is required.
-const VERSION_CODE = 1002003; // VERSION_CODE variable is required.
-
-export default ({ config }: ConfigContext): ExpoConfig => {
-  return {
-    ...config,
-    version: VERSION_NAME,
-    ios: {
-      buildNumber: VERSION_CODE + '',
-    },
-    android: {
-      versionCode: VERSION_CODE,
-    },
-  };
-};
-
-```
-
-## 5. Update `.gitignore`
-
-```gitignore
-# Expo Release It
-
-expo-release-it/.temp
-android/vendor/bundle
-ios/vendor/bundle
-!*.jks
-!*.p8
-!*.keystore
-```
-
-## 6. Run `expo-release-it init`
-
-# Usage
-
-```shell
-npx expo-release-it (init|bump|pull|build|upload|submit) [options]
-```
-
-All commands are powered by [Commander.js](https://github.com/tj/commander.js?) means you can query all available options with `--help` or `-h`.
-
-## init
-
-**Configure resources and environment**
-
-```shell
-npx expo-release-it init
-```
-
-The `init` command asks you for many form fields, and the information is saved in `expo-release-it/keyholder.json` in your project.
-
-Even after running `init`, you can manually edit `keyholder.json`, and all subsequent commands will use the updated values.
-
-The resources & output directory structure is the following.
-
-```text
-📁 expo-release-it/
-├── 📁 key/         # key & certificate files
-├── 📁 metadata/    # result of `pull`
-│   ├── 📁 android/  # android store metadatas
-│   └── 📁 ios/      # ios store metadatas
-├── 📁 output/      # result of `build`
-│   ├── 📁 android/  # android build output
-│   └── 📁 ios/      # ios build output
-└── keyholder.json
-```
-
-## bump
-
-**Bump binary release patch version with modifying expo config file**
-
-```shell
-npx expo-release-it bump
-```
-
-## pull
-
-**Download metadatas from stores**
-
-```shell
-npx expo-release-it pull
-```
-
-The downloaded metadatas are stored in `expo-release-it/metadata`.
-
-Check the following out to configure metadatas.
-
-- [Android Metadata Manage Guide](https://docs.fastlane.tools/actions/supply/#images-and-screenshots)
-- [iOS Metadata Manage Guide](https://docs.fastlane.tools/actions/deliver/#available-language-codes)
-
-
-## build
-
-**Build artifacts (apk, aab, ipa)**
-
-```shell
-npx expo-release-it build
-```
-
-## upload
-
-**Upload artifact to play console internal test track(android) and testflight(ios)**
-
-```shell
-npx expo-release-it upload
-```
-
-## submit
-
-**Submit Google Play Console & App Store Connect Review with latest testing track**
-
-```shell
-npx expo-release-it submit
-```
-
-# About Security
-
-That’s right. You might be wondering whether storing files like .p8, keystore files, or key values in version control is truly secure.
-In conclusion, if you’re using a private repository, you can consider it to be somewhat safe.
-
-For example, Fastlane Match also uses OpenSSL encryption, but it still stores certificates and profiles in a private Git repository.
-
-While you could implement additional security policies, I haven’t taken any extra measures for now.
-If you need further encryption, you can build middleware in your pipeline that runs expo-release-it so that everything in the expo-release-it directory goes through encryption and decryption processes.
-
-Any suggestions are welcome.
-
-# Troubleshooting
-
-## [iOS - submit] Add information to the :submission_information option...
-
-Add [Complying with Encryption Export Regulartions options](https://developer.apple.com/documentation/security/complying-with-encryption-export-regulations?language=objc) to your expo config file.
-
-Example `app.json`
-
-```json
-{
-  "expo": {
-    "ios": {
-      "config": {
-        "usesNonExemptEncryption": false
-      }
-    }
-  }
-}
-```
-
-## [iOS] failed to load command: fastlane
-
-This means lane of fastlane has been failed. You must check stdout of fastlane action in console.
-
-### invalid curve name
-
-check out if contents of `ios_app_store_connect_api_key.p8` are valid.
-
-## [iOS - submit] The provided entity is missing a required attribute - ...
-
-You have to fill required metadata attributes of iOS in `expo-release-it/metadata/ios`.
-
-You also skip uploading metadatas with opt out the metadata uploading from the cli prompt.
-
-## [iOS - submit]  This resource cannot be reviewed
-
-You have to fill all necessary metadata to submit app for the reivew.
-
-Check yourself if app can be submitted manually at the app store connect yourself first.
-
-## [iOS] Provisioning profile "..." doesn't include signing certificate "..."
-
-You might need to revoke iOS Certificates & Provisioning Profile and generate again.
-
-```shell
-cd ios
-bundle
-bundle exec fastlane match nuke distribution # revoke all certificates
-
-cd ..
-npx expo-release-it built -p ios # command you tried, this generate required certificates automatically
-```
-
-## [Android] Google Api Error: Invalid request - Package not found: ...
-
-At first, you have to upload your artifacts manually.
-First, create an internal testing track and then upload your artifacts (AAB or APK files).
-
-## [Android] Google Api Error: Invalid request - Only releases with status draft may be created on draft app.
-
-If you have just created your app and have never released it to production before, please fill out all the required metadata manually, publish the app manually for the first time, and then try again.
+- ✅ Submit releases for store review
 
 # Licenses
 

package/build/command/build.js

@@ -58,17 +58,16 @@ var package_default = {
   name: "expo-release-it",
   module: "src/index.ts",
   type: "module",
-  version: "0.3.1",
+  version: "0.4.0",
   license: "MIT",
-  homepage: "https://github.com/mym0404/expo-release-it",
+  homepage: "https://expo-release-it.mjstudio.net/",
   repository: "https://github.com/mym0404/expo-release-it",
   scripts: {
-    build: "tsup",
-    dev: "yarn run build && NODE_ENV=development node bin/expo-release-it.mjs",
-    release: "yarn build && release-it",
-    android: "expo run:android",
-    ios: "expo run:ios",
-    t: "tsc --noEmit -p ."
+    build: "pnpm build:json-schema-type && tsup",
+    "build:json-schema-type": "json2ts --input expo-release-it.schema.json --output src/type/ExpoReleaseItConfiguration.d.ts",
+    dev: "pnpm build && NODE_ENV=development node bin/expo-release-it.mjs",
+    release: "pnpm build && pnpm run t && release-it",
+    t: "lefthook run check"
   },
   dependencies: {
     "@inquirer/prompts": "^7.4.1",
@@ -78,8 +77,8 @@ var package_default = {
     execa: "^9.5.2",
     "fs-extra": "^11.3.0",
     ora: "^8.2.0",
-    react: "18.3.1",
-    "react-native": "0.76.9",
+    react: "catalog:native",
+    "react-native": "catalog:native",
     semver: "^7.7.1",
     url: "^0.11.4"
   },
@@ -88,29 +87,29 @@ var package_default = {
     "@release-it/conventional-changelog": "^10.0.1",
     "@types/fs-extra": "^11.0.4",
     "@types/semver": "^7.7.0",
+    "json-schema-to-typescript": "^15.0.4",
     lefthook: "^1.11.11",
-    prettier: "3.5.3",
+    prettier: "catalog:",
     "release-it": "^19.0.1",
     "tiny-glob": "^0.2.9",
     tsup: "^8.4.0",
-    typescript: "^5.8.3"
+    typescript: "catalog:",
+    vitest: "^3.1.2"
   },
-  workspaces: [
-    "example"
-  ],
   bin: "./bin/expo-release-it.mjs",
   files: [
     "build",
     "package.json",
     "bin",
-    "template"
+    "template",
+    "expo-release-it.schema.json"
   ],
-  packageManager: "yarn@4.9.1",
   commitlint: {
     extends: [
       "@commitlint/config-conventional"
     ]
-  }
+  },
+  packageManager: "pnpm@10.10.0+sha512.d615db246fe70f25dcfea6d8d73dee782ce23e2245e3c4f6f888249fb568149318637dca73c2c5c8ef2a4ca0d5657fb9567188bfab47f566d1ee6ce987815c39"
 };
 
 // src/util/OptionHolder.ts
@@ -121,7 +120,9 @@ var OptionHolder = {
     rootDir: resolve2(fileURLToPath(import.meta.url), "../.."),
     templateDir: resolve2(fileURLToPath(import.meta.url), "../../template")
   },
-  input: {},
+  input: {
+    git: {}
+  },
   keyholderMap: {},
   templateDirNames: ["key"],
   projectDir: "",
@@ -319,6 +320,11 @@ async function hydrateKeyholderFileValues() {
   }
 }
 
+// src/util/EnvUtil.ts
+var isDev = process.env.NODE_ENV === "development";
+var isWin = process.platform.startsWith("win");
+var isTest = process.env.NODE_ENV === "test";
+
 // src/util/throwError.ts
 function throwError(message, e) {
   if (e) {
@@ -326,11 +332,15 @@ function throwError(message, e) {
   } else {
     logger.error(message);
   }
+  if (isTest) {
+    throw new Error("throwError");
+  }
   process.exit(1);
 }
 
 // src/util/setup/VersionUtil.ts
 import semver from "semver";
+import { padZero } from "@mj-studio/js-util";
 var versionNameRegex = () => /const\s+VERSION_NAME\s*?=\s*?['"]([\d\.]*?)['"]\s*?;?/;
 var versionCodeRegex = () => /const\s+VERSION_CODE\s*?=\s*?(\d+)\s*?;?/;
 async function parseBinaryVersions() {
@@ -388,13 +398,65 @@ async function parseBinaryVersions() {
   }
 }
 
-// src/util/EnvUtil.ts
-var isDev = process.env.NODE_ENV === "development";
-var isWin = process.platform.startsWith("win");
+// src/util/parseConfigFile.ts
+import { is } from "@mj-studio/js-util";
+async function parseConfigFile() {
+  const candidates = [
+    join2(OptionHolder.resourcesDir, "expo-release-it.config.json"),
+    join2(OptionHolder.projectDir, "expo-release-it.config.json")
+  ];
+  if (OptionHolder.input.config) {
+    candidates.unshift(OptionHolder.input.config);
+  }
+  const validConfigFilePath = candidates.find(
+    (candidate) => exist(candidate) && is.object(readJsonSlow(candidate))
+  );
+  if (!validConfigFilePath) return;
+  const config = readJsonSlow(validConfigFilePath);
+  assignIfValueIsValidAndNotSetAlready(
+    OptionHolder.input,
+    "semverIncrement",
+    config.bump?.increment
+  );
+  assignIfValueIsValidAndNotSetAlready(
+    OptionHolder.input,
+    "androidOutput",
+    config.build?.androidBuildOutput ?? config.upload?.androidBuildOutput
+  );
+  assignIfValueIsValidAndNotSetAlready(
+    OptionHolder.input,
+    "uploadMetadata",
+    config.upload?.uploadMetadata ?? config.submit?.uploadMetadata
+  );
+  assignIfValueIsValidAndNotSetAlready(
+    OptionHolder.input,
+    "uploadScreenshot",
+    config.upload?.uploadScreenshot ?? config.submit?.uploadScreenshot
+  );
+  assignIfValueIsValidAndNotSetAlready(OptionHolder.input.git, "commit", config.bump?.git?.commit);
+  assignIfValueIsValidAndNotSetAlready(
+    OptionHolder.input.git,
+    "commitMessage",
+    config.bump?.git?.commitMessage
+  );
+  assignIfValueIsValidAndNotSetAlready(OptionHolder.input.git, "tag", config.bump?.git?.tag);
+  assignIfValueIsValidAndNotSetAlready(
+    OptionHolder.input.git,
+    "tagName",
+    config.bump?.git?.tagName
+  );
+  assignIfValueIsValidAndNotSetAlready(OptionHolder.input.git, "push", config.bump?.git?.push);
+}
+function assignIfValueIsValidAndNotSetAlready(object, key, value) {
+  if (!object[key] && value) {
+    object[key] = value;
+  }
+}
 
 // src/util/setup/setup.ts
 async function setup() {
   await setupBasicOptions();
+  await parseConfigFile();
   await hydrateKeyholderFileValues();
   await parseBinaryVersions();
 }
@@ -435,17 +497,17 @@ async function prepareIos() {
 import chalk5 from "chalk";
 
 // src/util/calculateElapsed.ts
-import { padZero } from "@mj-studio/js-util";
+import { padZero as padZero2 } from "@mj-studio/js-util";
 function calculateElapsed(t) {
   let seconds = Math.floor((Date.now() - t) / 1e3);
   const minutes = Math.floor(seconds / 60);
   seconds = seconds % 60;
-  return `${minutes}:${padZero(seconds)}`;
+  return `${minutes}:${padZero2(seconds)}`;
 }
 
 // src/util/input/InqueryInputs.ts
 import { select } from "@inquirer/prompts";
-import { is } from "@mj-studio/js-util";
+import { is as is2 } from "@mj-studio/js-util";
 import chalk4 from "chalk";
 var InqueryInputs = {
   platform: async () => {
@@ -462,21 +524,6 @@ var InqueryInputs = {
       });
     }
   },
-  platformAll: async () => {
-    if (!OptionHolder.input.platformAll) {
-      OptionHolder.input.platformAll = await select({
-        message: constructInquirerFormattedMessage({
-          name: "Platform",
-          explanation: `Platforms to run action`
-        }),
-        choices: [
-          { name: "all", value: "all", description: "Both" },
-          { name: "ios", value: "ios", description: "Release ios" },
-          { name: "android", value: "android", description: "Release android" }
-        ]
-      });
-    }
-  },
   podinstall: async () => {
     if (OptionHolder.input.platform === "ios") {
       OptionHolder.input.pod = await select({
@@ -506,7 +553,7 @@ var InqueryInputs = {
     }
   },
   uploadMetadata: async () => {
-    if (!is.boolean(OptionHolder.input.uploadMetadata)) {
+    if (!is2.boolean(OptionHolder.input.uploadMetadata)) {
       OptionHolder.input.uploadMetadata = await select({
         message: constructInquirerFormattedMessage({
           name: "Upload Text Metadata(title, description, ...)"
@@ -519,7 +566,7 @@ var InqueryInputs = {
     }
   },
   uploadScreenshot: async () => {
-    if (!is.boolean(OptionHolder.input.uploadScreenshot)) {
+    if (!is2.boolean(OptionHolder.input.uploadScreenshot)) {
       OptionHolder.input.uploadScreenshot = await select({
         message: constructInquirerFormattedMessage({
           name: "Upload Screenshots & Images"
@@ -532,7 +579,7 @@ var InqueryInputs = {
     }
   },
   useLiveVersionIos: async () => {
-    if (!is.boolean(OptionHolder.input.useLiveVersionIos) && OptionHolder.input.platform === "ios") {
+    if (!is2.boolean(OptionHolder.input.useLiveVersionIos) && OptionHolder.input.platform === "ios") {
       OptionHolder.input.useLiveVersionIos = await select({
         message: constructInquirerFormattedMessage({
           name: "Download metadatas from live version rather than draft"