fix: adjust docs on how to stringify parsed object payloads

[pjungermann]

Closes: #111
Signed-off-by: Patrick Jungermann Patrick.Jungermann@gmail.com

---

Behavior

Before the change?

After the change?

Other information

As I wrote at issue #111 not sure if this is the correct resolution. I still prepared it as it is a simple change.

---

Additional info

Pull request checklist

• Tests for the changes have been added (for bug fixes / features)
• Docs have been reviewed and added / updated if needed (for bug fixes / features)
• Added the appropriate label for the given change

Does this introduce a breaking change?

Please see our docs on breaking changes to help!

• Yes (Please add the Type: Breaking change label)
• No

If Yes, what's the impact:

• N/A

Pull request type

Please add the corresponding label for change this PR introduces:

• Bugfix: Type: Bug
• Feature/model/API additions: Type: Feature
• Updates to docs or samples: Type: Documentation
• Dependencies/code cleanup: Type: Maintenance

---

[gr2m]

Hmm I'm pretty sure that GitHub's event JSON payloads are not on a single line, they have space indentation and line breaks.

In your test you do a simple stringify:
https://github.com/backstage/backstage/pull/14689/files#diff-8a3494f5371a5d5b692b3c2792bd1dc4292839676128d1776dae6974915bd386R51-R52

But that's not what GitHub does. Did you confirm that it failed before hand in production and that your change fixes it? I'd like someone to confirm that is the case independently before we merge the pull request

[pjungermann]

I've changed the code after verifying this behavior with a real webhook event payload and its signature received from GitHub. I didn't want to put a real payload into the tests though.

As far as I can tell, they seem to send the payload in one line. Using JSON.stringify(payload) works on parsed payload objects with the real signature value.

@frenchbread was the one reporting this to me originally.

Of course, it is good to get/make another independent cross-check.

[github-actions]

🎉 This PR is included in version 3.0.2 🎉

The release is available on:

• GitHub release
• npm package (@latest dist-tag)

Your semantic-release bot 📦🚀