Skip to content

feat(cicd-github-actions): add support for workflow description #129

@neilime

Description

@neilime

GitHub Action workflow do not have "description" field, so we had to get from comment at the beginning of the yaml file.

Example:

# Workflow to greet new contributors.
# Mainly using [First Interaction Action](https://github.com/actions/first-interaction), with some opinionated defaults.
# - On issue creation, a comment is added to the issue.
# - On first contribution, a comment is added to the pull request.
---
name: Greetings

on:
  issues:
    types: [opened]
  pull_request_target:
    branches: [main]

  workflow_call:
    inputs:
      runs-on:
        description: "JSON array of runner(s) to use. See <https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job>."
        type: string
        default: '["ubuntu-latest"]'
        required: false

description should be:

Workflow to greet new contributors.
Mainly using [First Interaction Action](https://github.com/actions/first-interaction), with some opinionated defaults.
- On issue creation, a comment is added to the issue.
- On first contribution, a comment is added to the pull request.

Metadata

Metadata

Assignees

Labels

No labels
No labels

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions