Apps API workflows list does not contain workflow from YAML

[WernerRaathAtPolymorph]

If you are looking for help, please confirm the following...

• I confirm I have searched the Docs, Codemagic Sample Projects, and GitHub Discussions.
• I confirm the software versions on my local computer match the ones in CI environment (e.g. Xcode version, Gradle version). See here
• I confirm I am able to do a fresh clone of the repository and build the project on my local computer.

Which mobile framework are you using?

Flutter (Dart)

Steps to reproduce

For file get_app_id_workflow_id.sh,
executed as ./get_app_id_workflow_id.sh <my_cm_token> does not return a workflow with the name in question. The only workflow for my app is a Default Workflow which I'm not even using...

CODEMAGIC_API_TOKEN=$1
APP_NAME=abcd
WEB_WORKFLOW_NAME=Web Workflow


get_codemagic_app_json() {
    local app_name=$1
    response=$(curl -s -H "x-auth-token: $CODEMAGIC_API_TOKEN" "https://api.codemagic.io/apps")
    app_json=$(echo "$response" | jq -r --arg app_name "$app_name" '.applications[] | select(.appName == $app_name) | .')
    echo "$app_json"
}

get_codemagic_app_id() {
    local app_json=$1
    app_id=$(echo "$app_json" | jq -r '._id')
    echo "$app_id"
}

get_codemagic_workflow_id() {
  local app_json=$1
  local workflow_name="$2"
  workflow_id=$(echo "$app_json" | jq -r --arg workflow_name "$workflow_name" '.workflows | to_entries[] | select(.value.name == $workflow_name) | .key')

  echo "$workflow_id"
}

APP_JSON=$(get_codemagic_app_json "$APP_NAME")
APP_ID=$(get_codemagic_app_id "$APP_JSON")
echo APP_ID=$APP_ID
WEB_WORKFLOW_ID=$(get_codemagic_workflow_id "$APP_JSON" "$WEB_WORKFLOW_NAME")
echo $WEB_WORKFLOW_ID

An example of my codemagic.yaml file is as follows:

scripts:
  - &prepare_flutter_deps
    name: Prepare Flutter Dependencies
    script: flutter packages pub get
  # Web
  - &build_web_release
    name: Build Web release
    script: flutter build web --release

variables:
  SLACK_CHANNEL: "#abcd"
  EMAIL_RECIPIENT: abcd

workflows:
  web-workflow:
    name: Web Workflow
    max_build_duration: 60
    environment:
      flutter: stable
      vars:
        SLACK_CHANNEL: $SLACK_CHANNEL
        EMAIL_RECIPIENT: $EMAIL_RECIPIENT
    scripts:
      - *prepare_flutter_deps
      - *build_web_release
    artifacts:
        # Web
        - build/web
    publishing:
      email:
        recipients:
          - $EMAIL_RECIPIENT
      slack:
        channel: $SLACK_CHANNEL
        notify_on_build_start: true

Expected results

"https://api.codemagic.io/apps" should return my applications with all of their workflows and not just the "Default Workflow"

Actual results

"workflows": {
    "abcd": {
      "_id": "abcd",
      "name": "Default Workflow",
      "isPublic": false,
      "branchPatterns": [],
      "tagPatterns": [],
      "instanceType": "mac_mini_m1",
      "maxBuildDuration": 3600,
      "testRunners": {
        "flutterAnalyze": {},
        "flutterTest": {
          "frameworkType": "flutter_test"
        },
        "flutterDrive": {
          "frameworkType": "flutter_driver"
        },
        "stopBuildIfTestsFail": true
      },
      "lastUpdated": {
        "date": "2024-04-14T19:02:08.116000+00:00",
        "user": {
          "name": "abcd",
          "email": "abcd"
        }
      },
      "publishers": {
        "email": {
          "recipients": [
            "abcd"
          ],
          "enabled": true
        },
        "slack": {},
        "staticPages": {},
        "s3StaticPages": {},
        "googlePlay": {
          "credentials": {},
          "track": null,
          "customTrack": null,
          "inAppUpdatePriority": null,
          "rolloutFraction": null,
          "submitAsDraft": null,
          "changesNotSentForReview": false,
          "enabled": null,
          "publishWhenFail": null
        },
        "appStoreConnect": {
          "appStoreConnectKeyId": null,
          "submitToAppStore": false,
          "releaseType": null,
          "earliestReleaseDate": null,
          "copyright": null,
          "submitToTestflight": false,
          "submitToBetaGroups": false,
          "betaGroups": [],
          "publishWhenFail": null,
          "enabled": null
        },
        "snapcraft": {
          "enabled": false,
          "channel": null,
          "snapTitle": null,
          "credentials": null
        },
        "firebase": {
          "enabled": false,
          "authenticationMethod": "firebase_token",
          "firebaseToken": null,
          "firebaseServiceAccount": null,
          "publishWhenFail": false,
          "artifactType": "auto",
          "ios": {
            "appId": null,
            "groups": []
          },
          "android": {
            "appId": null,
            "groups": []
          }
        },
        "partnerCenter": {
          "partnerCenterTenantName": null,
          "storeId": null,
          "tenantId": null,
          "clientId": null,
          "clientSecret": null,
          "enabled": null,
          "publishWhenFail": null,
          "msixArguments": {
            "name": null,
            "publisher": null,
            "publisherDisplayName": null,
            "version": null
          }
        }
      },
      "codeSigning": {
        "android": {
          "enabled": false,
          "keyAlias": null,
          "keyPassword": null,
          "keystore": null,
          "keystorePassword": null
        },
        "ios": {
          "appStoreConnectKeyId": null,
          "developerPortalBundleIdentifier": null,
          "developerPortalPassword": null,
          "developerPortalProfileType": null,
          "developerPortalUsername": null,
          "enabled": null,
          "signingMethod": null,
          "certificatePassword": null,
          "developerCertificate": null,
          "encryptedKey": null,
          "provisioningProfiles": [],
          "developerPortalTeamId": null
        },
        "macos": {
          "appStoreConnectKeyId": null,
          "developerPortalTeamId": null,
          "developerPortalBundleIdentifier": null,
          "developerPortalPassword": null,
          "developerPortalProfileType": null,
          "isMacCatalyst": false,
          "signingMethod": null,
          "enabled": null,
          "appCertificate": null,
          "appCertificateEncryptedKey": null,
          "appCertificatePassword": null,
          "installerCertificate": null,
          "installerCertificateEncryptedKey": null,
          "installerCertificatePassword": null,
          "provisioningProfiles": []
        }
      },
      "customScripts": {
        "postClone": "",
        "preBuild": "",
        "postBuild": "",
        "preTest": "",
        "postTest": "",
        "prePublish": "",
        "postPublish": ""
      },
      "buildSettings": {
        "automaticBuilds": false,
        "buildOnPrUpdate": false,
        "tagBuilds": false,
        "cancelPreviousBuilds": false,
        "cancelPending": true,
        "target": "debug",
        "projectFile": ".",
        "flutterMode": "debug",
        "platforms": [
          "android",
          "ios"
        ],
        "flutterVersion": "stable",
        "cocoapodsVersion": "default",
        "xcodeVersion": "latest",
        "flutterVerbose": false,
        "androidBuildOutputFormat": "aab",
        "flutterPackageWindows": false
      },
      "environmentVariables": [],
      "dependencyCache": {
        "cachePaths": [],
        "enabled": false
      }
    }
  },
  

Build id (optional)

No response

[mikhail-tokarev]

HI @WernerRaathAtPolymorph thanks for your question and trying Codemagic 🙌

since codemagic.yaml content stored in Git repository, we don't fetch it for this endpoint for many reasons (mainly security and performance) and won't be able to provide this information for you. I understand it's not the answer you expected and if you share more information about your case, I believe we can figure out some solution here. We can continue discuss it here or feel free to contact our team via in-app chat.

[WernerRaathAtPolymorph]

Cool beans - what I'd like to do is trigger a build pipeline via the builds API, but I need the right workflowId to make sure I run the right workflow

[mikhail-tokarev]

yeah in this case you need to hardcode the name since you likely won't change it often

[WernerRaathAtPolymorph]

Ah okay so you can use clear text there! Great! Thanks @mikhail-tokarev! That sorted me out

[WernerRaathAtPolymorph]

You can use the Workflow Name as the workflowId and it will resolve yaml dependencies.

This means that you should not use the App API to get workflow etc information for any yaml configured pipelines