runner icon indicating copy to clipboard operation
runner copied to clipboard

Show composite action name at step level

Open bombillazo opened this issue 2 years ago • 30 comments

Describe the bug Given the use of a custom composite action:

# Composite Action ./.github/actions/build-api/action.yml
name: 'Build API'
description: 'Build the API'
runs:
  using: 'composite'
  steps:
    ...

# Main Workflow
name: Deploy
on:
  push:
    branches:
      - main

jobs:
  deploy:
    name: Build API
    runs-on: ubuntu-latest
    steps:
      - name: Checkout repo code
        uses: actions/checkout@v3
      # Configure Environments
      - uses: ./.github/actions/build-api

The runners do not show the step name of the composite action, instead a generic Run action... step name. Having to update this step name when it can be extracted from the action itself can get tedious when managing lots of actions and workflows.

To Reproduce Steps to reproduce the behavior:

  1. Setup a composite action
  2. Do not give a name to the step when using the composite action
  3. Run the action

Expected behavior The runner shows the name of the composite action for the step taken from the composite action metadata.

Runner Version and Platform

Version of your runner?

OS of the machine running the runner? All

What's not working?

image

bombillazo avatar May 05 '22 21:05 bombillazo

Hi @bombillazo,

Thanks for reporting this issue! I agree with everything written, if the step name is not defined, the name of the action itself should be displayed. I added this to the board so we will work on it and create a PR that solves this problem.

ruvceskistefan avatar May 06 '22 09:05 ruvceskistefan

The same can be done for action steps. For example, given that composite action

name: 'Action name'
runs:
  using: 'composite'
  steps:
    - name: Action step 1
      run: go mod download
      working-directory: ${{ github.action_path }}
      shell: bash

I get

image

Both "Action name" and "Action step 1" are not visible. runs.steps.name is a required field, but seems to be unused.

AlekSi avatar May 07 '22 07:05 AlekSi

I would be also great if each step could be "collapsable" in the same way it is for other types of actions

acabarbaye avatar Nov 22 '22 17:11 acabarbaye

Until this is properly fixed, is there any workaround to show a nicer name in the action output?

zupo avatar Mar 01 '23 20:03 zupo

still waiting for this

joaoluiznaufel avatar Mar 29 '23 13:03 joaoluiznaufel

Still waiting for this too 🙏 This is a big advantage to be able to create a clean code bases with composite actions, without compromising readability in the UI...

anthonwellsjo avatar Mar 29 '23 17:03 anthonwellsjo

still waiting for this as well

cezar-tech avatar Jun 13 '23 19:06 cezar-tech

+1 awaiter here

asvishnyakov avatar Jul 06 '23 10:07 asvishnyakov

+1 awaiter here (2)

basimbd avatar Oct 11 '23 12:10 basimbd

It's been a while since I created this issue, I just wanted to follow up with the GH Actions team, given it's had much support since then.

@DanRigby @TingluoHuang @vanZeben @fhammerl

bombillazo avatar Oct 11 '23 13:10 bombillazo

*anxiously awaiting for this as well 😅

alan-sanchez2-kr avatar Oct 24 '23 12:10 alan-sanchez2-kr

+1

jamesloosli avatar Nov 01 '23 18:11 jamesloosli

+1

Marcin-Lach avatar Nov 22 '23 07:11 Marcin-Lach

+1 Still waiting

brandonja991 avatar Dec 29 '23 16:12 brandonja991

+1 waiting too

ArminArdekani avatar Jan 18 '24 21:01 ArminArdekani

+1 awaiter here

fabianorosa1 avatar Jan 22 '24 14:01 fabianorosa1

+1 still waiting

KarimGl avatar Jan 25 '24 13:01 KarimGl

+1 still waiting

nuryupin-kr avatar Feb 08 '24 15:02 nuryupin-kr

+1 awaiter here

paveldedourek-eaton avatar Feb 27 '24 11:02 paveldedourek-eaton

Knowing that GHA renders 1st line of the run script as step title, this workaround allows to have nicer rendering:

    - name: Verify installed ASDF tools
      shell: bash
      run: |
        : Verify installed ASDF tools
        awk '{print $1}' .tool-versions \
          ...

that provides nice rendering:

collapsed: Screenshot 2024-03-10 at 14 11 01

expanded: Screenshot 2024-03-10 at 14 09 40

Instead of : step name, one might use true shell - step name Screenshot 2024-03-10 at 14 12 44

Both : and true commands do not affect execution flow

jaymecd avatar Mar 10 '24 13:03 jaymecd

Knowing that GHA renders 1st line of the run script as step title, this workaround allows to have nicer rendering:

Clever workaround... but we shouldn't have to do that.

dkfellows avatar Mar 10 '24 19:03 dkfellows

+1

afernandez-01 avatar Apr 22 '24 23:04 afernandez-01

+1

ramilbakhshyiev avatar Apr 27 '24 08:04 ramilbakhshyiev

I would like to have this ❤️

setoelkahfi avatar May 14 '24 11:05 setoelkahfi

+1

atsu85 avatar May 21 '24 13:05 atsu85

I forgot to celebrate my baby's second birthday... 😞 Happy birthday, #1877!

bombillazo avatar May 21 '24 14:05 bombillazo

And another +1 👍

jackhicks-thrive avatar May 29 '24 10:05 jackhicks-thrive

+42

ziadsarour avatar Jun 09 '24 03:06 ziadsarour

+100500

kifir23917 avatar Jun 27 '24 10:06 kifir23917