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

Clarify configuration requirements, provide examples #32

Open
yuriybabenko opened this issue May 6, 2024 · 0 comments
Open

Clarify configuration requirements, provide examples #32

yuriybabenko opened this issue May 6, 2024 · 0 comments

Comments

@yuriybabenko
Copy link

It is not clear from the Readme and other available documentation what configuration is required and where.

I'm working on handling GitHub hooks, and it has been frustrating to run into error after error while attempting to integrate the "drop-in" package.

For example, nowhere does it specify that my application's /config/services.php needs to be updated to include a webhook_secret configuration value, and that the same value needs to be configured in the GitHub webhook:

'github' => [
  'webhook_secret' => env('GITHUB_WEBHOOK_SECRET'),
],

I'd imagine there are similar requirements for other providers, too.

Improving the docs in this regard would go a long way towards easier package adoption.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant