expo-release-it 0.1.3 → 0.1.5

package/README.md

@@ -2,22 +2,28 @@
 
 ![expo-release-it thumbnail](./asset/social-image.png)
 
-Opinioned Expo CICD workflow CLI for building & uploading & submitting Expo CNG project on your machine
+Opinionated Expo CICD workflow CLI for building & uploading & submitting Expo projects on your machine
 
 > [!CAUTION]
-> This project is under developing.
+> This project is under development.
 
 # Features
 
-- No EAS
-- Manage Keys, Credentials, Metadatas in a simple way 
-- Working with CNG mode (also available with non CNG environment)
-- Build artifacts locally (`apk`, `aab`, `ipa`)
-- Upload artifacts to Google Play Console Internal Testing Track & iOS Testflight
-- Submit releases for review
+- 🎉 No **EAS**
+- 🩵 No headaches when understanding and managing **keys and credentials**
+- 🧩 Manage and sync **store metadata** easily
+- 🌍 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.
@@ -26,42 +32,228 @@ Based on years of experience developing with React Native, I encourage a more tr
 
 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>
 
-# Requirements
+# Structurual Requirements
 
-- Match iOS, Android Binary build version like `1.0.0`
-- All Keys, Credentials(except iOS certificates & provisioning profiles) are stored in VCS
+- `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.
+
+- [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|build|upload|submit) [options]
+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/)
+- [iOS Metadata Manage Guide](https://docs.fastlane.tools/actions/deliver/)
+
+
 ## 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
 
-# Limitation
+**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
 
+# Licenses
 
 - See [LICENSE](/LICENSE)
 

package/build/command/build.js

@@ -58,8 +58,10 @@ var package_default = {
   name: "expo-release-it",
   module: "src/index.ts",
   type: "module",
-  version: "0.1.2",
+  version: "0.1.4",
   license: "MIT",
+  homepage: "https://github.com/mym0404/expo-release-it",
+  repository: "https://github.com/mym0404/expo-release-it",
   scripts: {
     build: "tsup",
     dev: "yarn run build && NODE_ENV=development node bin/expo-release-it.mjs",
@@ -199,17 +201,29 @@ function copyIosMetadata(to) {
   const metadataResourcesDir = join2(resourcesDir, "metadata");
   const screenshotsResourcesDir = join2(resourcesDir, "screenshots");
   if (to === "resources") {
-    copy(metadataNativeDir, metadataResourcesDir);
-    copy(screenshotsNativeDir, screenshotsResourcesDir);
-    logger.done(
-      `iOS Metadata saved in ${chalk3.inverse(relativePath(OptionHolder.projectDir, resourcesDir))}. You can edit inside contents.`
-    );
+    if (exist(metadataNativeDir) && exist(screenshotsNativeDir)) {
+      copy(metadataNativeDir, metadataResourcesDir);
+      copy(screenshotsNativeDir, screenshotsResourcesDir);
+      logger.done(
+        `iOS Metadata saved in ${chalk3.inverse(relativePath(OptionHolder.projectDir, resourcesDir))}. You can edit inside contents.`
+      );
+    } else {
+      logger.warn(
+        `iOS Metadata not found in ${chalk3.inverse(relativePath(OptionHolder.projectDir, nativeDir))}`
+      );
+    }
   } else {
-    copy(metadataResourcesDir, metadataNativeDir);
-    copy(screenshotsResourcesDir, screenshotsNativeDir);
-    logger.done(
-      `iOS Metadata copyed to ${chalk3.inverse(relativePath(OptionHolder.projectDir, nativeDir))}`
-    );
+    if (exist(metadataResourcesDir) && exist(screenshotsResourcesDir)) {
+      copy(metadataResourcesDir, metadataNativeDir);
+      copy(screenshotsResourcesDir, screenshotsNativeDir);
+      logger.done(
+        `iOS Metadata copyed to ${chalk3.inverse(relativePath(OptionHolder.projectDir, nativeDir))}`
+      );
+    } else {
+      logger.warn(
+        `iOS Metadata not found in ${chalk3.inverse(relativePath(OptionHolder.projectDir, resourcesDir))}`
+      );
+    }
   }
 }
 function copyAndroidMetadata(to) {
@@ -217,15 +231,27 @@ function copyAndroidMetadata(to) {
   const nativeDir = join2(androidDir, "fastlane/metadata/android");
   const resourcesDir = join2(OptionHolder.resourcesDir, "metadata/android");
   if (to === "resouces") {
-    copy(nativeDir, resourcesDir);
-    logger.done(
-      `Android Metadata saved in ${chalk3.inverse(relativePath(OptionHolder.projectDir, resourcesDir))}. You can edit inside contents.`
-    );
+    if (exist(nativeDir)) {
+      copy(nativeDir, resourcesDir);
+      logger.done(
+        `Android Metadata saved in ${chalk3.inverse(relativePath(OptionHolder.projectDir, resourcesDir))}. You can edit inside contents.`
+      );
+    } else {
+      logger.warn(
+        `Android Metadata not found in ${chalk3.inverse(relativePath(OptionHolder.projectDir, nativeDir))}`
+      );
+    }
   } else {
-    copy(resourcesDir, nativeDir);
-    logger.done(
-      `Android Metadata copyed to ${chalk3.inverse(relativePath(OptionHolder.projectDir, nativeDir))}`
-    );
+    if (exist(resourcesDir)) {
+      copy(resourcesDir, nativeDir);
+      logger.done(
+        `Android Metadata copyed to ${chalk3.inverse(relativePath(OptionHolder.projectDir, nativeDir))}`
+      );
+    } else {
+      logger.warn(
+        `Android Metadata not found in ${chalk3.inverse(relativePath(OptionHolder.projectDir, resourcesDir))}`
+      );
+    }
   }
 }
 
@@ -250,7 +276,7 @@ async function prepareAndroid() {
     "Hydrate template placeholders",
     injectTemplatePlaceHolders(resolve2(destDir, "fastlane"))
   );
-  await exe({ cwd: destDir })`bundle install`;
+  await exe("bundle", ["install"], { cwd: destDir });
   logger.success("Bunder Install - Done");
   copyAndroidMetadata("native");
 }
@@ -267,7 +293,7 @@ async function replaceAndroidSigningConfig(destDir) {
     `
   signingConfigs {
     debug {
-        storeFile file('${relativePath(buildGradleDirPath, resolve2(OptionHolder.resourcesDir, "key", "android_release_keystore.jks"))}')
+        storeFile file('${relativePath(buildGradleDirPath, resolve2(OptionHolder.resourcesDir, "key", "android_release.keystore"))}')
         storePassword '${android_keystore_store_password}'
         keyAlias '${android_keystore_key_alias}'
         keyPassword '${android_keystore_key_password}'
@@ -297,6 +323,8 @@ function throwError(message, e) {
 
 // src/util/setup/VersionUtil.ts
 import semver from "semver";
+var versionNameRegex = () => /const\s+VERSION_NAME\s*?=\s*?['"]([\d\.]*?)['"]\s*?;?/;
+var versionCodeRegex = () => /const\s+VERSION_CODE\s*?=\s*?(\d+)\s*?;?/;
 async function parseBinaryVersions() {
   const files = readdir(OptionHolder.projectDir);
   const jsConfigFiles = ["app.config.ts", "app.config.js", "app.config.cjs", "app.config.mjs"];
@@ -315,8 +343,8 @@ async function parseBinaryVersions() {
   async function parseFromJsConfigFile(filename) {
     const filePath = resolve2(OptionHolder.projectDir, filename);
     const content = read(filePath);
-    const VERSION_NAME = /const VERSION_NAME = '(.*?)';/.exec(content)?.[1];
-    const VERSION_CODE = /const VERSION_CODE = (.*?);/.exec(content)?.[1];
+    const VERSION_NAME = versionNameRegex().exec(content)?.[1];
+    const VERSION_CODE = versionCodeRegex().exec(content)?.[1];
     if (!VERSION_NAME) {
       throwError("cannot parse version name");
     }
@@ -390,7 +418,7 @@ async function prepareIos() {
     "Hydrate template placeholders",
     injectTemplatePlaceHolders(resolve2(destDir, "fastlane"))
   );
-  await exe({ cwd: destDir })`bundle install`;
+  await exe("bundle", ["install"], { cwd: destDir });
   logger.success("Bunder Install - Done");
   copyIosMetadata("native");
 }
@@ -426,6 +454,21 @@ 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({
@@ -503,7 +546,7 @@ function getIosFastlaneOptions() {
     ...Object.entries(OptionHolder.keyholderMap).map(([k, v]) => `${k}:${v}`),
     `version_name:${OptionHolder.versionName}`,
     `version_code:${OptionHolder.versionCode}`,
-    `api_key_filepath:${resolve2(OptionHolder.keyDir, "ios_testflight_upload_api_key.p8")}`,
+    `api_key_filepath:${resolve2(OptionHolder.keyDir, "ios_app_store_connect_api_key.p8")}`,
     `upload_metadata:${OptionHolder.input.uploadMetadata}`,
     `ipa_path:${resolve2(OptionHolder.resourcesDir, "output", "ios", "app.ipa")}`,
     `ipa_dir:${resolve2(OptionHolder.resourcesDir, "output", "ios")}`,
@@ -518,7 +561,6 @@ async function build({ options }) {
   await setup();
   await promptInputs();
   logger.info("Build Started");
-  logger.info(`Version: ${OptionHolder.versionName}(${OptionHolder.versionCode})`);
   if (OptionHolder.input.platform === "ios") {
     await buildIos();
     logger.success(`iOS Build ${chalk5.bold.inverse(calculateElapsed(startTime))}`);