Webhook payload. Is accessible for scripts?

[bahag-chandrana]

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

I am trying to utilize the Pull title from the event payload which is the trigger for our workflow. This works well in the when condition section as described in the documentation. For e.g. following works.

    when:
      condition: (not event.pull_request.draft) or (event.pull_request.labels[0].name == "run-codemagic")

However when I try to access the same payload in one of the scripts its not working. For e.g. as shown below.

      - name: Set up release notes
        script: |
          echo $(event.pull_request.title) | jq '.' > $FCI_BUILD_DIR/release_notes.json
          cat $FCI_BUILD_DIR/release_notes.json

Is there a specific way to access this webhoook payload within the scripts.

Expected results

the PR title is accessible in the command line.

Actual results

Its not clear how to access it in the scripts section.

Build id (optional)

No response

[dtrdic]

hey @bahag-chandrana in Codemagic, accessing the event payload directly within scripts isn't straightforward because the event object isn't available for direct execution. The when condition can evaluate event payloads because it’s processed in a different phase of the workflow execution. However, you can achieve something similar by creating a script that generates release notes for a pull request (PR) using the GitHub CLI (gh) to fetch the PR title.

1. First you need to create a personal access token as described in the GitHub documentation.

2. Next, add this token as an environment variable in Codemagic and reference it in your workflow.
   

3. Then add this script to your build

scripts:   
  - name: Generating release notes with PR title from GitHub API    
    script: |
        # Fetch the pull request title using the GitHub CLI and the PR number
        PR_TITLE=$(gh pr view $CM_PULL_REQUEST_NUMBER --json title -q '.title')

        # Create the release notes file with just the PR title
        echo "Release Notes for PR: $PR_TITLE" > release_notes.txt

        # Display the generated release notes
        cat release_notes.txt

[dtrdic]

I'm tentatively closing the discussion since we haven't heard back from you. You can open the discussion again by replying to this message or opening a new discussion.