Skip to content

feat: Generate a CI summary of a command #904

@mbevc1

Description

@mbevc1

In order to bubble up visibility when we run CLI in the CI (WhichCI()) we want to generate a friendly summer, .e.g GitHub has step summaries, where dumping a MD to a $GITHUB_STEP_SUMMARY will be displayed in Actions: https://github.blog/news-insights/product-news/supercharging-github-actions-with-job-summaries/

There is not direct equivalent of this in GitLab, but there is an issue opened: https://gitlab.com/gitlab-org/gitlab/-/work_items/21647 . So we can add a summary for GH but perhaps create a summary.md for GL and that can be then added as an artefact as part of the job.

We also want to have an ENV variable to disable creating the MD file, to restore current behaviour if needed.

We should probably add this to all commands.

Metadata

Metadata

Assignees

No one assigned
    No fields configured for Feature.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions