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

Option to use GitHub App's "Checks API" instead of PR comments #936

Open
MPV opened this issue Feb 27, 2020 · 5 comments
Open

Option to use GitHub App's "Checks API" instead of PR comments #936

MPV opened this issue Feb 27, 2020 · 5 comments
Labels
feature New functionality/enhancement help wanted Good feature for contributors

Comments

@MPV
Copy link

MPV commented Feb 27, 2020

Hi,
I'd like to propose using the "GitHub Checks API" for delivering even nicer feedback into GitHub pull requests.

Here's two examples of how it looks when the Google Cloud Build GitHub app does this:

Success example:

ghgooglecloudbuild

Failure example:

2IPZt

Some possible benefits:

  1. It shows all runs in a collected list under the Checks tab. Compared to today, where Atlantis plan/applies are intermingled with discussions/changes to the PR. I imagine both could be valuable, and this condensed list could help in some cases.
  2. We could decide (or configure?) whether it should show the output from the Terraform commands directly in the PR, or just link to somewhere "safe" where the right people could access the output (and maybe help with issues like QUESTION: Terraform plan output may contain sensitive data.  #163).

Since the GitHub Checks API seems to require tying it to a GitHub app, I imagine it might mean each installation/usage of Atlantis might require the owners to set up their own private app, but that might be fine.

@pratikmallya
Copy link
Contributor

Since this depends on atlantis being configured as a Github app, it seems to require #418

@lkysow lkysow added the feature New functionality/enhancement label Mar 2, 2020
@unRob unRob mentioned this issue Apr 5, 2020
5 tasks
@evanstachowiak
Copy link

Now that #971 is completed (thanks @unRob !), any status on getting this implemented?

@nitrocode
Copy link
Member

nitrocode commented Oct 6, 2022

This would put atlantis more on-par with competitors like Spacelift

https://docs.spacelift.io/integrations/source-control/github

@jamengual jamengual added the help wanted Good feature for contributors label Oct 6, 2022
@jamengual
Copy link
Contributor

PRs will be welcome :)

@nitrocode nitrocode changed the title Use GitHub Checks API Use GitHub Checks API instead of PR comments Nov 19, 2022
@nitrocode nitrocode changed the title Use GitHub Checks API instead of PR comments Option to use GitHub App's "Checks API" instead of PR comments Nov 19, 2022
@nitrocode
Copy link
Member

nitrocode commented Nov 23, 2022

It appears the lyft fork has this setup and they previously attempted to upstream the changes here #2217 but it fell into git conflicts and became stale.

If anyone is interested in taking the changes, fixing conflicts, testing, and opening up a new PR, then we can get it merged 😄 .

Notable in the lyft fork.

https://github.com/lyft/atlantis/blob/4c6dfb9739a84b7db10a8978023a6c8a13dff691/server/events/vcs/github_client.go#L515-L518

https://github.com/lyft/atlantis/blob/4c6dfb9739a84b7db10a8978023a6c8a13dff691/server/events/vcs/github_client.go#L545-L546

Edit: Using the checks api results in github app in a "job summary" (and "job summaries") style output (for issue searchers). It's also possible that a job summary output can be used with or without checks api meaning the github app is not 100% necessary for summaries.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature New functionality/enhancement help wanted Good feature for contributors
Projects
None yet
Development

No branches or pull requests

6 participants