Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make scopes and types YAML lists #203

Open
jszwedko opened this issue Oct 4, 2022 · 1 comment
Open

Make scopes and types YAML lists #203

jszwedko opened this issue Oct 4, 2022 · 1 comment

Comments

@jszwedko
Copy link
Contributor

jszwedko commented Oct 4, 2022

Hey all,

We'd like to have comments around our lists of types and scopes but because they are YAML scalars, this isn't possible. For example, we'd like to write:

        with:
          types: |
            chore               # An internal change this is not observable by users.
            enhancement         # Any user observable enhancement to an existing feature.

But the comments are included in the scalar.

Ideally we could provide the types and scopes as actual lists like:

        with:
          types: |
          - chore               # An internal change this is not observable by users.
          - enhancement         # Any user observable enhancement to an existing feature.

Is there a reason the types and scopes are newline delimited strings rather than being YAML lists? Would you be open to a (breaking) PR changing that?

@amannn
Copy link
Owner

amannn commented Oct 5, 2022

Hi and thanks for your request! As far as I know GitHub actions don't support arrays as input parameters, that's why we went with the multiline strings. Can you confirm?

I see that comments are useful though, so I'd be open to remove them during parsing if you'd like to contribute this feature.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants