eas-cli 16.21.0 → 16.22.0

package/build/commandUtils/workflow/creation.js

@@ -0,0 +1,462 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.customizeTemplateIfNeededAsync = exports.ensureProductionBuildProfileExistsAsync = exports.addBuildJobsToDevelopmentBuildTemplateAsync = exports.workflowStarters = exports.howToRunWorkflow = exports.WorkflowStarterName = void 0;
+const tslib_1 = require("tslib");
+const eas_build_job_1 = require("@expo/eas-build-job");
+const buildProfileUtils_1 = require("./buildProfileUtils");
+const log_1 = tslib_1.__importStar(require("../../log"));
+const prompts_1 = require("../../prompts");
+const easCli_1 = require("../../utils/easCli");
+var WorkflowStarterName;
+(function (WorkflowStarterName) {
+    WorkflowStarterName["BUILD"] = "build";
+    WorkflowStarterName["UPDATE"] = "update";
+    WorkflowStarterName["CUSTOM"] = "custom";
+    WorkflowStarterName["DEPLOY"] = "deploy";
+})(WorkflowStarterName || (exports.WorkflowStarterName = WorkflowStarterName = {}));
+const createdByEASCLI = `# Created by EAS CLI v${easCli_1.easCliVersion}`;
+const CUSTOM_TEMPLATE = {
+    name: 'Custom workflow',
+    on: {
+        push: {
+            branches: ['main'],
+        },
+    },
+    jobs: {
+        custom_build: {
+            name: 'Custom job',
+            steps: [
+                {
+                    uses: 'eas/checkout',
+                },
+                {
+                    name: 'Hello World',
+                    id: 'hello_world',
+                    run: '# Custom script\necho "Hello, World"\n',
+                },
+            ],
+        },
+    },
+};
+const CUSTOM_TEMPLATE_HEADER = `
+# Custom job
+#
+# This workflow shows how to write custom jobs.
+# It contains a predefined workflow step and a shell command to print "Hello, World!".
+#
+# Key features:
+# - Triggers on pushes to the main branch.
+#    (Requires linked GitHub account: https://expo.dev/accounts/[account]/settings/github)
+# - Can be triggered manually with eas workflow:run custom.yml
+# - Runs eas/checkout then a custom "echo" command
+#
+# For detailed documentation on workflow syntax and available step types, visit:
+# https://docs.expo.dev/eas/workflows/syntax/#jobsjob_idstepsstepuses
+#
+${createdByEASCLI}
+#
+`;
+const BUILD_TEMPLATE = {
+    name: 'Create development builds',
+    on: {
+        push: {
+            branches: ['main'],
+        },
+    },
+    jobs: {},
+};
+const BUILD_TEMPLATE_HEADER = `
+# Create development builds
+#
+# This workflow shows how to create development builds.
+#
+# Key features:
+# - Can be triggered manually with eas workflow:run create-development-builds.yml
+# - Runs the pre-packaged build job to create Android and iOS development builds
+#     for Android emulators, Android and iOS devices, and iOS simulators
+#
+# For a detailed guide on using this workflow, visit:
+# https://docs.expo.dev/develop/development-builds/introduction/
+#
+${createdByEASCLI}
+#
+`;
+const PUBLISH_UPDATE_TEMPLATE = {
+    name: 'Publish preview update',
+    on: {
+        push: {
+            branches: ['*'],
+        },
+    },
+    jobs: {
+        publish_preview_update: {
+            name: 'Publish preview update',
+            type: 'update',
+            params: {
+                branch: '${{ github.ref_name || "test" }}',
+            },
+        },
+    },
+};
+const PUBLISH_UPDATE_TEMPLATE_HEADER = `
+# Publish preview update
+#
+# This workflow shows how to publish preview updates.
+# Learn more: https://docs.expo.dev/review/share-previews-with-your-team/
+#
+# Key features:
+# - Triggers on pushes to all branches
+#    (Requires linked GitHub account: https://expo.dev/accounts/[account]/settings/github)
+# - Can be triggered manually with eas workflow:run publish-preview-update.yml
+# - Runs the pre-packaged update job
+#
+# For a detailed guide on using this workflow, visit:
+# https://docs.expo.dev/eas/workflows/examples/publish-preview-update/
+#
+${createdByEASCLI}
+#
+`;
+const DEPLOY_TEMPLATE = {
+    name: 'Deploy to production',
+    on: {
+        push: {
+            branches: ['main'],
+        },
+    },
+    jobs: {
+        fingerprint: {
+            name: 'Fingerprint',
+            type: 'fingerprint',
+        },
+        get_android_build: {
+            name: 'Check for existing android build',
+            needs: ['fingerprint'],
+            type: 'get-build',
+            params: {
+                fingerprint_hash: '${{ needs.fingerprint.outputs.android_fingerprint_hash }}',
+                profile: 'production',
+            },
+        },
+        get_ios_build: {
+            name: 'Check for existing ios build',
+            needs: ['fingerprint'],
+            type: 'get-build',
+            params: {
+                fingerprint_hash: '${{ needs.fingerprint.outputs.ios_fingerprint_hash }}',
+                profile: 'production',
+            },
+        },
+        build_android: {
+            name: 'Build Android',
+            needs: ['get_android_build'],
+            if: '${{ !needs.get_android_build.outputs.build_id }}',
+            type: 'build',
+            params: {
+                platform: 'android',
+                profile: 'production',
+            },
+        },
+        build_ios: {
+            name: 'Build iOS',
+            needs: ['get_ios_build'],
+            if: '${{ !needs.get_ios_build.outputs.build_id }}',
+            type: 'build',
+            params: {
+                platform: 'ios',
+                profile: 'production',
+            },
+        },
+        submit_android_build: {
+            name: 'Submit Android Build',
+            needs: ['build_android'],
+            type: 'submit',
+            params: {
+                build_id: '${{ needs.build_android.outputs.build_id }}',
+            },
+        },
+        submit_ios_build: {
+            name: 'Submit iOS Build',
+            needs: ['build_ios'],
+            type: 'submit',
+            params: {
+                build_id: '${{ needs.build_ios.outputs.build_id }}',
+            },
+        },
+        publish_android_update: {
+            name: 'Publish Android update',
+            needs: ['get_android_build'],
+            if: '${{ needs.get_android_build.outputs.build_id }}',
+            type: 'update',
+            params: {
+                branch: 'production',
+                platform: 'android',
+            },
+        },
+        publish_ios_update: {
+            name: 'Publish iOS update',
+            needs: ['get_ios_build'],
+            if: '${{ needs.get_ios_build.outputs.build_id }}',
+            type: 'update',
+            params: {
+                branch: 'production',
+                platform: 'ios',
+            },
+        },
+    },
+};
+const DEPLOY_TEMPLATE_HEADER = `
+# Deploy to production
+#
+# This workflow shows how to build and submit to app stores.
+#
+# Key features:
+# - Triggers on pushes to "main" (Requires linked GitHub account: https://expo.dev/accounts/[account]/settings/github)
+# - Can be triggered manually with eas workflow:run deploy-to-production.yml
+# - Creates builds and submits them to app stores when native changes are detected, otherwise sends an over-the-air update.
+#
+# For a detailed guide on using this workflow, visit:
+# https://docs.expo.dev/eas/workflows/examples/deploy-to-production/
+`;
+function nextStepForDeviceBuildProfile(buildProfileName) {
+    return `A build job in this workflow uses the build profile "${buildProfileName}"
+    to build your app for real devices, and may require credentials.
+    You can configure your credentials with the command "eas credentials".
+    For more information, please see ${(0, log_1.link)('https://docs.expo.dev/app-signing/app-credentials/')}.
+`
+        .trim()
+        .trimStart();
+}
+function nextStepForAppSubmission() {
+    return `This workflow includes a job to submit your app to app stores.
+    You will need to configure your App Store/Play Store credentials 
+    before you can run this workflow.
+    Please see ${(0, log_1.link)('https://docs.expo.dev/deploy/submit-to-app-stores/')}.
+  `
+        .trim()
+        .trimStart();
+}
+function howToRunWorkflow(workflowFileName, workflowStarter) {
+    const lines = [
+        `To run this workflow manually, use the command "eas workflow:run .eas/workflows/${workflowFileName}".`,
+    ];
+    if (workflowStarter.template?.on?.push?.branches?.length > 0) {
+        const branches = workflowStarter.template.on.push.branches;
+        if (branches.length === 1 && branches[0] === '*') {
+            lines.push('This workflow is also configured to run automatically when code is pushed to any branch.');
+        }
+        else if (branches.length === 1) {
+            lines.push(`This workflow is also configured to run automatically when code is pushed to the "${branches[0]}" branch.`);
+        }
+        else {
+            lines.push(`This workflow is also configured to run automatically when code is pushed to the following branches: ${branches.join(', ')}.`);
+        }
+    }
+    return lines.join('\n');
+}
+exports.howToRunWorkflow = howToRunWorkflow;
+exports.workflowStarters = [
+    {
+        displayName: 'Custom',
+        name: WorkflowStarterName.CUSTOM,
+        defaultFileName: 'custom.yml',
+        template: CUSTOM_TEMPLATE,
+        header: CUSTOM_TEMPLATE_HEADER,
+    },
+    {
+        displayName: 'Create development builds',
+        name: WorkflowStarterName.BUILD,
+        defaultFileName: 'create-development-builds.yml',
+        template: BUILD_TEMPLATE,
+        header: BUILD_TEMPLATE_HEADER,
+    },
+    {
+        displayName: 'Publish updates',
+        name: WorkflowStarterName.UPDATE,
+        defaultFileName: 'publish-updates.yml',
+        template: PUBLISH_UPDATE_TEMPLATE,
+        header: PUBLISH_UPDATE_TEMPLATE_HEADER,
+    },
+    {
+        displayName: 'Deploy to production',
+        name: WorkflowStarterName.DEPLOY,
+        defaultFileName: 'deploy-to-production.yml',
+        template: DEPLOY_TEMPLATE,
+        header: DEPLOY_TEMPLATE_HEADER,
+    },
+];
+async function addBuildJobsToDevelopmentBuildTemplateAsync(projectDir, workflowStarter) {
+    const buildProfiles = await (0, buildProfileUtils_1.buildProfilesFromProjectAsync)(projectDir);
+    // android_development_build
+    const nextSteps = new Set();
+    let androidDevelopmentBuildProfileName = null;
+    for (const profileName of buildProfiles.keys()) {
+        const profile = buildProfiles.get(profileName)?.android;
+        if (!profile) {
+            continue;
+        }
+        if ((0, buildProfileUtils_1.isBuildProfileForDevelopment)(profile, eas_build_job_1.Platform.ANDROID)) {
+            androidDevelopmentBuildProfileName = profileName;
+            break;
+        }
+    }
+    if (!androidDevelopmentBuildProfileName) {
+        log_1.default.warn('This workflow requires an Android development build profile in your eas.json, but none were found.');
+        const add = await (0, prompts_1.confirmAsync)({
+            message: 'Do you want to add an Android development build profile?',
+            initial: false,
+        });
+        if (add) {
+            let androidDevelopmentBuildProfileName = 'android_development';
+            while (buildProfiles.has(androidDevelopmentBuildProfileName)) {
+                androidDevelopmentBuildProfileName = `${androidDevelopmentBuildProfileName}_1`;
+            }
+            await (0, buildProfileUtils_1.addAndroidDevelopmentBuildProfileToEasJsonAsync)(projectDir, androidDevelopmentBuildProfileName);
+        }
+        else {
+            log_1.default.log('Skipping Android development build job...');
+        }
+    }
+    if (androidDevelopmentBuildProfileName) {
+        log_1.default.log(`Using Android development build profile: ${androidDevelopmentBuildProfileName}`);
+        workflowStarter.template.jobs.android_development_build = {
+            name: `Build ${androidDevelopmentBuildProfileName} for android`,
+            type: 'build',
+            params: {
+                profile: androidDevelopmentBuildProfileName,
+                platform: 'android',
+            },
+        };
+        nextSteps.add(nextStepForDeviceBuildProfile(androidDevelopmentBuildProfileName));
+    }
+    // ios_simulator_development_build
+    let iosSimulatorDevelopmentBuildProfileName = null;
+    for (const profileName of buildProfiles.keys()) {
+        const profile = buildProfiles.get(profileName)?.ios;
+        if (!profile) {
+            continue;
+        }
+        if ((0, buildProfileUtils_1.isBuildProfileForDevelopment)(profile, eas_build_job_1.Platform.IOS) &&
+            (0, buildProfileUtils_1.isIosBuildProfileForSimulator)(profile)) {
+            iosSimulatorDevelopmentBuildProfileName = profileName;
+            break;
+        }
+    }
+    if (!iosSimulatorDevelopmentBuildProfileName) {
+        log_1.default.warn('This workflow requires an iOS simulator development build profile in your eas.json, but none were found.');
+        const add = await (0, prompts_1.confirmAsync)({
+            message: 'Do you want to add an iOS simulator development build profile?',
+            initial: false,
+        });
+        if (add) {
+            let iosSimulatorDevelopmentBuildProfileName = 'ios_simulator_development';
+            while (buildProfiles.has(iosSimulatorDevelopmentBuildProfileName)) {
+                iosSimulatorDevelopmentBuildProfileName = `${iosSimulatorDevelopmentBuildProfileName}_1`;
+            }
+            await (0, buildProfileUtils_1.addIosDevelopmentBuildProfileToEasJsonAsync)(projectDir, iosSimulatorDevelopmentBuildProfileName, true);
+        }
+        else {
+            log_1.default.log('Skipping iOS simulator development build job...');
+        }
+    }
+    if (iosSimulatorDevelopmentBuildProfileName) {
+        log_1.default.log(`Using iOS simulator development build profile: ${iosSimulatorDevelopmentBuildProfileName}`);
+        workflowStarter.template.jobs.ios_simulator_development_build = {
+            name: `Build ${iosSimulatorDevelopmentBuildProfileName} for iOS simulator`,
+            type: 'build',
+            params: {
+                profile: iosSimulatorDevelopmentBuildProfileName,
+                platform: 'ios',
+            },
+        };
+    }
+    // ios_device_development_build
+    let iosDeviceDevelopmentBuildProfileName = null;
+    for (const profileName of buildProfiles.keys()) {
+        const profile = buildProfiles.get(profileName)?.ios;
+        if (!profile) {
+            continue;
+        }
+        if ((0, buildProfileUtils_1.isBuildProfileForDevelopment)(profile, eas_build_job_1.Platform.IOS) &&
+            !(0, buildProfileUtils_1.isIosBuildProfileForSimulator)(profile)) {
+            iosDeviceDevelopmentBuildProfileName = profileName;
+            break;
+        }
+    }
+    if (!iosDeviceDevelopmentBuildProfileName) {
+        log_1.default.warn('This workflow requires an iOS device development build profile in your eas.json, but none were found.');
+        const add = await (0, prompts_1.confirmAsync)({
+            message: 'Do you want to add an iOS device development build profile?',
+            initial: false,
+        });
+        if (add) {
+            let iosDeviceDevelopmentBuildProfileName = 'ios_device_development';
+            while (buildProfiles.has(iosDeviceDevelopmentBuildProfileName)) {
+                iosDeviceDevelopmentBuildProfileName = `${iosDeviceDevelopmentBuildProfileName}_1`;
+            }
+            await (0, buildProfileUtils_1.addIosDevelopmentBuildProfileToEasJsonAsync)(projectDir, iosDeviceDevelopmentBuildProfileName, false);
+        }
+        else {
+            log_1.default.log('Skipping iOS device development build job...');
+        }
+    }
+    if (iosDeviceDevelopmentBuildProfileName) {
+        log_1.default.log(`Using iOS device development build profile: ${iosDeviceDevelopmentBuildProfileName}`);
+        workflowStarter.template.jobs.ios_development_build = {
+            name: `Build ${iosDeviceDevelopmentBuildProfileName} for iOS simulator`,
+            type: 'build',
+            params: {
+                profile: iosDeviceDevelopmentBuildProfileName,
+                platform: 'ios',
+            },
+        };
+        nextSteps.add(nextStepForDeviceBuildProfile(iosDeviceDevelopmentBuildProfileName));
+    }
+    workflowStarter.nextSteps = [...nextSteps];
+    return workflowStarter;
+}
+exports.addBuildJobsToDevelopmentBuildTemplateAsync = addBuildJobsToDevelopmentBuildTemplateAsync;
+async function ensureProductionBuildProfileExistsAsync(projectDir, workflowStarter) {
+    await (0, buildProfileUtils_1.addProductionBuildProfileToEasJsonIfNeededAsync)(projectDir);
+    workflowStarter.nextSteps = [
+        nextStepForDeviceBuildProfile('production'),
+        nextStepForAppSubmission(),
+    ];
+    return workflowStarter;
+}
+exports.ensureProductionBuildProfileExistsAsync = ensureProductionBuildProfileExistsAsync;
+async function customizeTemplateIfNeededAsync(workflowStarter, projectDir, expoConfig) {
+    // Ensure EAS Build is configured
+    switch (workflowStarter.name) {
+        case WorkflowStarterName.BUILD:
+        case WorkflowStarterName.DEPLOY:
+        case WorkflowStarterName.UPDATE:
+            if (!(await (0, buildProfileUtils_1.hasBuildConfigureBeenRunAsync)({ projectDir, expoConfig }))) {
+                throw new Error('EAS Build is not configured for this project. Please run "eas build:configure" to configure it.');
+            }
+            break;
+        default:
+            break;
+    }
+    // Ensure EAS Update is configured
+    switch (workflowStarter.name) {
+        case WorkflowStarterName.DEPLOY:
+        case WorkflowStarterName.UPDATE:
+            if (!(await (0, buildProfileUtils_1.hasUpdateConfigureBeenRunAsync)({ projectDir, expoConfig }))) {
+                throw new Error('EAS Update is not configured for this project. Please run "eas update:configure" to configure it.');
+            }
+            break;
+        default:
+            break;
+    }
+    // Customize template
+    switch (workflowStarter.name) {
+        case WorkflowStarterName.BUILD:
+            log_1.default.debug('Adding build jobs to template...');
+            return await addBuildJobsToDevelopmentBuildTemplateAsync(projectDir, workflowStarter);
+        case WorkflowStarterName.DEPLOY:
+            return await ensureProductionBuildProfileExistsAsync(projectDir, workflowStarter);
+        default:
+            return workflowStarter;
+    }
+}
+exports.customizeTemplateIfNeededAsync = customizeTemplateIfNeededAsync;

package/build/commandUtils/workflow/validation.d.ts

@@ -4,3 +4,7 @@ export declare function validateWorkflowFileAsync(workflowFileContents: {
     filePath: string;
 }, projectDir: string, graphqlClient: ExpoGraphqlClient, projectId: string): Promise<void>;
 export declare function logWorkflowValidationErrors(error: unknown): void;
+export declare function parsedYamlFromWorkflowContents(workflowFileContents: {
+    yamlConfig: string;
+}): any;
+export declare function workflowContentsFromParsedYaml(parsedYaml: any): string;

package/build/commandUtils/workflow/validation.js

@@ -1,13 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.logWorkflowValidationErrors = exports.validateWorkflowFileAsync = void 0;
+exports.workflowContentsFromParsedYaml = exports.parsedYamlFromWorkflowContents = exports.logWorkflowValidationErrors = exports.validateWorkflowFileAsync = void 0;
 const tslib_1 = require("tslib");
-const eas_json_1 = require("@expo/eas-json");
 const errors_1 = require("@expo/eas-json/build/errors");
 const core_1 = require("@urql/core");
 const fs_1 = require("fs");
 const path_1 = tslib_1.__importDefault(require("path"));
 const YAML = tslib_1.__importStar(require("yaml"));
+const buildProfileUtils_1 = require("./buildProfileUtils");
 const api_1 = require("../../api");
 const WorkflowRevisionMutation_1 = require("../../graphql/mutations/WorkflowRevisionMutation");
 const log_1 = tslib_1.__importDefault(require("../../log"));
@@ -82,8 +82,7 @@ async function validateWorkflowBuildJobsAsync(parsedYaml, projectDir) {
     if (buildJobs.length === 0) {
         return;
     }
-    const easJsonAccessor = eas_json_1.EasJsonAccessor.fromProjectPath(projectDir);
-    const buildProfileNames = new Set(easJsonAccessor && (await eas_json_1.EasJsonUtils.getBuildProfileNamesAsync(easJsonAccessor)));
+    const buildProfileNames = await (0, buildProfileUtils_1.buildProfileNamesFromProjectAsync)(projectDir);
     const invalidBuildJobs = buildJobs.filter(job => !buildProfileNames.has(job.value.params.profile) &&
         // If a profile name is interpolated, we can't check if it's valid until the workflow actually runs
         !buildProfileIsInterpolated(job.value.params.profile));
@@ -127,6 +126,11 @@ function parsedYamlFromWorkflowContents(workflowFileContents) {
     const parsedYaml = YAML.parse(workflowFileContents.yamlConfig);
     return parsedYaml;
 }
+exports.parsedYamlFromWorkflowContents = parsedYamlFromWorkflowContents;
+function workflowContentsFromParsedYaml(parsedYaml) {
+    return YAML.stringify(parsedYaml);
+}
+exports.workflowContentsFromParsedYaml = workflowContentsFromParsedYaml;
 // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
 async function fetchWorkflowSchemaAsync() {
     // EXPO_TESTING_WORKFLOW_SCHEMA_PATH is used only for testing against a different schema

package/build/commands/workflow/create.d.ts

@@ -7,12 +7,13 @@ export declare class WorkflowCreate extends EasCommand {
         required: boolean;
     }[];
     static flags: {
-        'non-interactive': import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        'skip-validation': import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
     };
     static contextDefinition: {
+        loggedIn: import("../../commandUtils/context/LoggedInContextField").default;
         projectDir: import("../../commandUtils/context/ProjectDirContextField").default;
+        getDynamicPublicProjectConfigAsync: import("../../commandUtils/context/DynamicProjectConfigContextField").DynamicPublicProjectConfigContextField;
+        getDynamicPrivateProjectConfigAsync: import("../../commandUtils/context/DynamicProjectConfigContextField").DynamicPrivateProjectConfigContextField;
     };
     runAsync(): Promise<void>;
-    private ensureWorkflowsDirectoryExistsAsync;
-    private createWorkflowFileAsync;
 }