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

Confusing documentation for GitHub Webhook Secret #345

Closed
crosiersource opened this issue Oct 21, 2020 · 1 comment
Closed

Confusing documentation for GitHub Webhook Secret #345

crosiersource opened this issue Oct 21, 2020 · 1 comment

Comments

@crosiersource
Copy link

Hi, first of all thank you for this wonderful plugin.
There's something that I think it's a little bit confused in the docs. It's about the "GitHub Webhook Secret".

Here in the docs: https://github.com/mantisbt-plugins/source-integration/blob/master/docs/CONFIGURING.SourceGithub.md, on the "Create a Repository" section, it says:

"The GitHub Webhook Secret is not mandatory, but provides additional security as it will allows the plugin to validate the payload received from the GitHub Webhook to ensure it's legit".

This Webhook I need to create manually? Like with the "openssl rand -hex 12" command?

I ask because on the "Setup the Webhook" section it just says "1. In the Update Repository page, next to GitHub Webhook Secret, click the Create Webhook button".

On the first repo I configured it seemed to work, but when I go to the Github admin's page, there's nothing in the "Secret" field there. And in the Payload URL there's nothing in the api_key parameter
It is just like this: https://mantis.myserver.com/plugin.php?page=Source/checkin&api_key=
GitHub Webhook Secret
And when I commit and push somenthing to my repo, there's no auto update on the "Changesets". To test the integration, I clicked on the "Import Latest Data" button. It catch the commits and succesfully attached to those Issues that I link in the commit's messages.

And on the second repo I tried to configure, after I click on the "Create Webhook" button a message "Not Found" shows up.

To fix this I used the "openssl rand -hex 12" and filled the "GitHub Webhook Secret" field on the "Update Repository". Then it seemed to work better, because now in the Github repo admin page the "Secret" is there, and the api_key parameter in the Payload URL is there too.

Now the auto update is working, but there's another problem: The link to my issue is there, on the commit's message, but that issue was not automatically attached. What could be wrong with my configuration?

Thank you

@crosiersource
Copy link
Author

Nevermind the "attach" problem. I didn't realize that I need to write "my message issue #999" to attach, I used just "my message #999".

Just think that need to update the docs with the thing about "GitHub Webhook Secret".

Thanks

dregad added a commit to dregad/source-integration that referenced this issue Jan 17, 2021
dregad added a commit to dregad/source-integration that referenced this issue Jan 17, 2021
dregad added a commit to dregad/source-integration that referenced this issue Jan 17, 2021
@dregad dregad changed the title GitHub Webhook Secret Confusing documentation for GitHub Webhook Secret Jan 18, 2021
@dregad dregad added this to the 2.4.1 milestone Jan 18, 2021
@dregad dregad closed this as completed in 50338db Jan 18, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants