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

docs(README): update Smee usage documentation #901

Merged
merged 1 commit into from
Sep 20, 2023

Conversation

monsonjeremy
Copy link
Contributor

Resolves #899


Before the change?

  • The current code in Smee documentation does not work as is, there is an error in the hmac.update call.

After the change?

  • We need to stringify the body in order to properly do the signature verification process.

Pull request checklist

  • [N/A] Tests for the changes have been added (for bug fixes / features)
  • [ x] Docs have been reviewed and added / updated if needed (for bug fixes / features)

Does this introduce a breaking change?

Please see our docs on breaking changes to help!

  • Yes
  • No

The current code in Smee documentation does not work as is, we need to stringify the body in order to properly do the signature verification process.
@wolfy1339 wolfy1339 added the Type: Documentation Improvements or additions to documentation label Sep 20, 2023
@wolfy1339 wolfy1339 changed the title GH-899: Update Smee Documentation docs(README): update Smee usage documentation Sep 20, 2023
@wolfy1339 wolfy1339 merged commit 2bfcb7a into octokit:main Sep 20, 2023
8 of 9 checks passed
Copy link
Contributor

🎉 This PR is included in version 12.0.4 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
released Type: Documentation Improvements or additions to documentation
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

[DOCS]: Smee setup documentation has an error
2 participants