Support workflow_dispatch event in GitHub Action

[lyleunderwood]

#307

I was trying to setup a manual chromatic runner using github actions via a github bot, and I wanted to use workflow_dispatch but this action didn't seem to allow it. I went ahead and added basic support.

[lyleunderwood]

It seems like chromatic only ever wants just the branch name, never the full ref (refs/heads/my-branch). Providing the full ref seems to result in chromatic always failing to compare to master. Does anybody have any insight into this point? Is there any reason I'd ever want to allow the full ref to pass through?

[ndelangen]

@lyleunderwood could you elaborate this question:

Is there any reason I'd ever want to allow the full ref to pass through?

[ghengeveld]

@lyleunderwood That's right, we basically never expect to see refs/heads/. We strip that off right here. Arguably the way we do it is slightly safer because the regex ensures it only strips it at the start of the string, never somewhere half way. It's unlikely someone would have an actual branch name like that, but theoretically possible.

@ndelangen Can you judge whether workflow_dispatch is safe for us to allow? If so, I think this is a nice improvement.

[ndelangen]

Can you judge whether workflow_dispatch is safe for us to allow? If so, I think this is a nice improvement.

Shall we add a test workflow in this repo and test it.

[lyleunderwood]

Hey, sorry I've been on vacation 🍹

I went ahead and updated the README to reflect that we really just want a regular branch name.

As for stripping off the ref prefix, it's currently just based on what's being done in the push case, let me know if I should remove it.

chromatic-cli/action/main.ts

Line 42 in 71e3c96

branch: event.payload.ref.replace('refs/heads/', ''),

[Manubi]

Will this get merged any time soon? :)