How to set PR title as run-name for merge_group job/wf

[kiran-pedduri-wdc]

Select Topic Area

Question

Body

I have a workflow on merge_group (below is the example), as the event for this workflow is merge_group, How can I set run-name as the PR title?

---

name: GK Job (Post PR verify Job)
run-name: ${{ github.event.pull_request.title }}

on:
merge_group:
branches:
- 'xyz'

[ivnvxd]

In GitHub Actions, the run-name field doesn't directly support the use of context expressions like ${{ github.event.pull_request.title }} to set dynamic names based on event payloads. This is primarily because the run-name is evaluated and set at the beginning of the workflow run, before many context variables are populated.

However, there's a workaround to achieve a similar result by using a step within your workflow to dynamically name your run, although it won't change the name of the workflow run itself, but can help in labeling or tagging steps or artifacts within the workflow.

name: GK Job (Post PR verify Job)

on:
  merge_group:
    branches:
      - 'xyz'

jobs:
  set-run-name:
    runs-on: ubuntu-latest
    steps:
      - name: Set Run Name
        run: echo "RUN_NAME=${{ github.event.pull_request.title }}" >> $GITHUB_ENV

In this example, a new job set-run-name is added to capture the PR title and set it as an environment variable RUN_NAME. You can then use this environment variable in subsequent steps or jobs within the same workflow.

The RUN_NAME will only be available in the steps after it is set, not in the initial stages of the workflow. It won't change the display name of the workflow run in the GitHub Actions UI.

[kiran-pedduri-wdc]

Hi @ivnvxd ,

Thanks for taking your time on this.
The requirement is to change the display name of the workflow run in the GitHub Actions UI

1. Here the workflow is on merge-group event so ${{ github.event.pull_request.title }} is null value.

2. Unable to use run-name in any job-steps or any other places other than line 2 (which is after workflow name)
   run-name: ${{ github.event.pull_request.title }}

3. I am able to fetch PR details from merge_group event below, but this includes PR title and Description (this is too big string display in GitHub Actions UI)
   run-name: "${{ github.event.merge_group.head_commit.message }}"
   

4. I see run-name supports expression. any possibility of display sub-string from above run-name?
   for Example just to display "DEVOPS1-537: PR Gatekeeper job shall reflect the PR details" which is until the chat '(#' in above string
   

[bdoyal]

I am interested in your use case as well, @kiran-pedduri-wdc. Did you find a way set the workflow run-name based on the originating pull request title when triggering your workflow from the merge_group event?

[michaelrosett]

I was planning on trying

run-name: ${{ github.event.merge_group.head_commit.message }}

In our case, the commit message will be the squash merge message which starts the same as the PR title followed by PR description. I'm hoping it will truncate correctly. I'll report back.

[michaelrosett]

⬆️ works but does not truncate. Don't think there's a way to truncate.

[github-actions[bot]]

🕒 Discussion Activity Reminder 🕒

This Discussion has been labeled as dormant by an automated system for having no activity in the last 60 days. Please consider one the following actions:

1️⃣ Close as Out of Date: If the topic is no longer relevant, close the Discussion as out of date at the bottom of the page.

2️⃣ Provide More Information: Share additional details or context — or let the community know if you've found a solution on your own.

3️⃣ Mark a Reply as Answer: If your question has been answered by a reply, mark the most helpful reply as the solution.

Note: This dormant notification will only apply to Discussions with the Question label. To learn more, see our recent announcement.

Thank you for helping bring this Discussion to a resolution! 💬