How can use the API to make an app use YAML configuration?

[abdoufma]

Hi,
I'm using the codemagic API automate most of my work , but now I want to add Environment variables to my apps (still using the API) and I'm getting the Workflow <workflowId> does not exist error as a response.

After digging, I found out that by default, all apps created using the API have their settingsSource attribute set to to ui, and isConfigured set to null which means that my codemagic.yaml configuration is simply being ignored!

Sure enough, upon switching the app to use YAML configuration from the UI, the API call worked.

This, however, doesn't solve my problem; I want automate the entire process, so I cannot afford to manually visit the editor everytime.

I haven't found anything in the docs about setting settingSource or preferUISettings to make an app respect the YAML configuration by default, hence my question here.

In my opinion, an App created by the API, should by default assume (or better yet, check) that a config file is present on the repo.

Is there a workaround I can use to achieve what I want here, or si that simply not possible at the moment?

[icarusdust]

Hi @abdoufma, you do not need to visit the editor nor change from the UI to yaml. However, please note that <workflowId> is in a number format when working with the UI. For ex, 6739674027sample4020 but with yaml, it would look like ios-workflow. Triggering a build via API will check your yaml anyways and if you want to override some values there, you can do it, if not, then values in yaml will be in place.

[abdoufma]

Hi @icarusdust
I am aware of that, however , it's still not respecting the yaml config for me

Here's what I'm doing :

1 - I'm creating an app (POST /apps/new) pointing to a repo that contains this config:

workflows:
  ios-env-var:
    name: iOS (Using Env Vars)
    max_build_duration: 120
    environment:
      groups:
        - ios_signing
      vars:
        XCODE_WORKSPACE: "Runner.xcworkspace"
        XCODE_SCHEME: "Runner"
        ...

2- I'm creating env variables (POST /apps/${newAppId}/variables with the following payload) :

{
	"key" : "APP_STORE_CONNECT_KEY_IDENTIFIER",
	"value" : "<KEY-ID>",
	"group" : "ios_signing",
	"workflowId" : "ios-env-var"
}

And I'm getting a 400 Error {"error": "Workflow ios-env-var does not exist"} as a response.

If I check the app info (GET /apps/${newAppId}) I get this :

{
    "workflowIds": [
			"6357b396ad1cdd82dc709906"
		],
		"workflows": {
			"6357b396ad1cdd82dc709906": {
				"_id": "6357b396ad1cdd82dc709906",
				"name": "Default Workflow",	
				"customScripts": {},
				"environmentVariables": [],
                                 ...
			}
		}
  }
		

So to me, it looks like my apps are preferring the Editor's config by default.

[abdoufma]

Edit: After a lot of digging, and some misleading SSH errors, I found a fix:

when creating the app, I was passing "projectType": "flutter-app" in the body, but I noticed that If I omit it, the subsequent request to create a variable works fine (even without specifying a workflowId, since the app is correctly in "YAML mode")

It appears that when it encounters flutter-app as the projectType, codemagic takes the configuration from the UI by default.

I experimented with other values for projectType just for fun and they all work fine, only flutter-app seems to be causing the issue.

Note : when projectType is omitted, the server gives a very limited response (only _id and appName)

Also note that this only happens when trying to add environment variables, starting builds for example, works fine.

Here's hoping that this gets fixed soon.

[dtrdic]

This discussion is being closed due to no activity in the last 14 days. You can reopen the discussion at any time if needed.