allow to use json file as is without replacing/parsing anything

[talgendler]

Summary

Allows to treat payload within a file unchanged, no replacing {{ similar to how one would specify payload with all the slack blocks etc but using template strings to be parsed by github itself.

Requirements (place an x in each [ ])

• I've read and understood the Contributing Guidelines and have done my best effort to follow them.
• I've read and agree to the Code of Conduct.

[zimeg]

Hey @talgendler 👋 Could you share a bit more about your use case? It's my understanding that payload-file-path is an alternative to payload and that these should behave similarly in regards to variable replacements.

[talgendler]

Hi @zimeg, you right, it works when you replace template variables with the values from github context. It doesn't replace values for functions or any boolean logic one might have like ${{ github.action == 'success' && 'Write this' || 'Write that' }}. Some will do all the calculation outside and only pass the calculated values to the file payload instead. For us it makes it much easier to share payloads between multiple repositories.

[zimeg]

It doesn't replace values for functions or any boolean logic

This is a great callout and a clever workaround is mentioned in #203 (comment) where more creative expressions are provided as environment variables. I think you're hinting at this already though!

I'm not against the change you're suggesting but I'm still trying to understand how you're planning to use an unparsed payload in your workflow and sharing these between repositories? I was imagining this was an alternative to file uploads (perhaps this is a good future enhancement) but it seems like you'd receive just the JSON payload file in your webhook URL and have to process it within Workflow Builder?

Apologies if I'm misunderstanding something and for the back-and-forth, I just want to make sure I'm grasping the gap this is addressing!

[zimeg]

Thanks for making these changes! I opened up finmenow#1 to swap the default value of payload-file-path-parsed to be true since we're replacing templated variables by default with this action. To me this matches the meaning of parsed a bit better.

Once those changes are included I'm feeling like this will be in a pretty good place. Of course, please let me know if you think the meaning of the false value shouldn't change!

[zimeg]

@talgendler thanks a ton for suggesting and implementing this feature! Going to tag a release after merging. 🚀