Skip to content

Confusing webhook doc notes for GitHub app #5734

@jreslock

Description

@jreslock

Per a slack thread I am submitting this issue and will be creating a PR to address it.

The current documentation for access-credentials.md contains two conflicting "notes" regarding webhook configuration requirements for the GitHub App setup that are confusing.

Here:

GitHub App handles the webhook calls by itself, hence there is no need to create webhooks separately. If webhooks were created manually, those should be removed when using GitHub App. Otherwise, there would be 2 calls to Atlantis resulting in locking errors on path/workspace.

Then also here

Webhooks must be created manually for repositories that trigger Atlantis.

This is somewhat confusing as the actual behavior is as follows:

The GitHub App can be configured to manage webhooks or not. If the app is configured to manage webhooks, the user should not create or manage the webhooks manually as this will cause locking errors and general instability.

I propose a new, combined note which explains this behavior in a more direct and clear way.

Community Note

  • Please vote on this issue by adding a 👍 reaction to the original issue to help the community and maintainers prioritize this request. Searching for pre-existing feature requests helps us consolidate datapoints for identical requirements into a single place, thank you!
  • Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request.
  • If you are interested in working on this issue or have submitted a pull request, please leave a comment.

Overview of the Issue

Reproduction Steps

Logs

Environment details

Additional Context

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't workingdocsDocumentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions