Description field for workflows to be shown in UI

[es-fabricemarie]

I am writing and more workflows to make full use of Actions, and while it's trivial to add comments in-line, I was wondering if it was possible to assign an official description to a workflow. I searched to no avail.

The goal is of course for action descriptions to be visible in the UI and explain to the user what they do before the user decides trigger it.

[ethomson]

Hi @es-fabricemarie - this is a really interesting idea. Can you give me a few examples of the places that you'd want to see this? (Screenshots would be great!)

[wolfe]

@ethomson --- I concur. It would be nice if a description is supplied such as:

name: Matisse Backend Pull Request
description: Test the backend and, upon success, deploy to ci

on:
  pull_request:

Then the UI displays "Test the backend and, upon success, deploy to ci" is shown in a small back font beneath (or to the right of) the blue filename

[es-fabricemarie]

Yes. Perfect example. Thanks.