Search code examples
githubgithub-actions

Description for a workflow in github actions


Is it possible to have a short comment/description for the job/workflow other than the name of the same.
sometimes it is difficult to identify the purpose or what it does just with the name when we have multiple jobs/workflows


Solution

  • You can put comments in the yaml file or put a readme.md in the workflow folder...

    # this is a comment in yaml
    

    There is no description yaml element to store stuff in.