octokit/webhooks-methods.js

[BUG]: docs for how to stringify parsed objects/payloads does not work

pjungermann opened this issue ยท 1 comments

What happened?

The documentation for sign and verify mention at eventPayloadString:

If you have only access to an already parsed object, stringify it with JSON.stringify(payload, null, 2) + '\n'

When trying this approach, we realized that we need to use JSON.stringify(payload) instead.

Not sure which is the intended version. The easiest resolution might be an update to the docs.

Context:
backstage/backstage#14689

Versions

"@octokit/webhooks-methods@npm:^3.0.0":
  version: 3.0.0
  resolution: "@octokit/webhooks-methods@npm:3.0.0"
  checksum: 3d1fdd051acb1e185160e138794b52b168a94dbd0fb05b1267914bfada199ccd615bc62828453b08edc5037557810319198c2684cfe5eba6267686952a9b644d
  languageName: node
  linkType: hard

Relevant log output

No response

Code of Conduct

  • I agree to follow this project's Code of Conduct

๐ŸŽ‰ This issue has been resolved in version 3.0.2 ๐ŸŽ‰

The release is available on:

Your semantic-release bot ๐Ÿ“ฆ๐Ÿš€