support GitHub Apps #1766

xuwei-k · 2020-11-25T17:57:15Z

fix #102

How to use

1. create `GitHub App`

https://github.com/settings/apps/new

`GitHub App name` set some appropriate name. e.g. `scala-steward-app` ?

`Homepage URL` set some appropriate url. e.g. `https://github.com/scala-steward-org` ?

not require `Webhook`

use `Metadata` `Read-only` permission only

not require another permissions

select `Any account`

2. Generate and save `Private Key`

go to https://github.com/settings/apps/{your application name}

Generate a private key

3. Install

https://github.com/apps/{your application name}/installations/new

select some organizations and/or repositories

4. run

--github-app-id is

--github-app-key-file is generated private key.

{application name}.{date}.private-key.pem

codecov · 2020-11-25T18:04:31Z

Codecov Report

Merging #1766 (80de957) into master (8274524) will decrease coverage by 1.93%.
The diff coverage is 3.63%.

@@            Coverage Diff             @@
##           master    #1766      +/-   ##
==========================================
- Coverage   76.52%   74.58%   -1.94%     
==========================================
  Files         118      123       +5     
  Lines        1989     2042      +53     
  Branches       56       58       +2     
==========================================
+ Hits         1522     1523       +1     
- Misses        467      519      +52

Impacted Files	Coverage Δ
.../scala/org/scalasteward/core/application/Cli.scala	`96.15% <ø> (ø)`
...la/org/scalasteward/core/application/Context.scala	`0.00% <ø> (ø)`
...org/scalasteward/core/application/StewardAlg.scala	`0.00% <0.00%> (ø)`
...scalasteward/core/vcs/github/GitHubAppApiAlg.scala	`0.00% <0.00%> (ø)`
...g/scalasteward/core/vcs/github/GitHubAuthAlg.scala	`0.00% <0.00%> (ø)`
...scalasteward/core/vcs/github/InstallationOut.scala	`0.00% <0.00%> (ø)`
...scalasteward/core/vcs/github/RepositoriesOut.scala	`0.00% <0.00%> (ø)`
...la/org/scalasteward/core/vcs/github/TokenOut.scala	`0.00% <0.00%> (ø)`
...ala/org/scalasteward/core/application/Config.scala	`90.00% <100.00%> (+0.34%)`	⬆️
... and 4 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 8274524...80de957. Read the comment docs.

project/Dependencies.scala

xuwei-k · 2020-11-26T04:48:11Z

example app

fthomas · 2020-11-26T08:20:12Z

Thanks for the PR @xuwei-k, this looks very interesting!

I've one question. The GitHub App is used to get the list of repositories (via installations) as an alternative to the repos file, right? So the usual Scala Steward user (instead of the GH App account) is still used for creating PRs.

xuwei-k · 2020-11-26T08:27:34Z

The GitHub App is used to get the list of repositories (via installations) as an alternative to the repos file, right? So the usual Scala Steward user (instead of the GH App account) is still used for creating PRs.

Yes, that's right.

fthomas

This LGTM, I only have a few minor comments.

fthomas · 2020-11-27T07:35:46Z

modules/core/src/main/scala/org/scalasteward/core/vcs/github/authentication.scala

+  }
+
+  /** [[https://docs.github.com/en/free-pro-team@latest/developers/apps/authenticating-with-github-apps#authenticating-as-a-github-app]] */
+  def createJWT(app: GitHubApp, ttl: Duration): String = {


This should be suspended in F[_] since it contains side effects (reading the key file and getting the current time).

I guess the ttl could also be a FiniteDuration since infinite Durations don't make much sense here.

project/Dependencies.scala

fthomas · 2020-11-27T07:43:02Z

modules/core/src/main/scala/org/scalasteward/core/application/StewardAlg.scala

@@ -44,7 +47,8 @@ final class StewardAlg[F[_]](config: Config)(implicit
    selfCheckAlg: SelfCheckAlg[F],
    streamCompiler: Stream.Compiler[F, F],
    workspaceAlg: WorkspaceAlg[F],
-    F: BracketThrow[F]
+    F: BracketThrow[F],
+    githubAppApiAlg: GitHubAppApiAlg[F]
 ) {


Nitpick: I find it nicer if the F parameter comes last and everything else is sorted alphabetically.

laughedelic · 2020-11-29T21:45:48Z

This looks great! @fthomas are you planning to set up an official Scala Steward app?

fthomas · 2020-11-30T07:10:59Z

Yes, I will and I'll post the details here when it is running.

fthomas · 2020-11-30T15:45:53Z

https://github.com/apps/scala-steward is now up and running. Feel free to try it but please don't publicize it. I'm not sure yet if it will completely replace the current repos.md. I fear that the app could lead to DOS attacks.

xuwei-k · 2020-12-01T16:22:32Z

modules/core/src/main/scala/org/scalasteward/core/vcs/github/GitHubAppApiAlg.scala

+
+  /** [[https://docs.github.com/en/free-pro-team@latest/rest/reference/apps#list-repositories-accessible-to-the-app-installation]]
+    *
+    * TODO pagination use `page` query param


fthomas · 2021-09-20T09:51:06Z

FYI: I disabled the https://github.com/apps/scala-steward app again. For all users of that app: if you want to continue receiving updates by Scala Steward, you can add your repo to https://github.com/scala-steward-org/repos/blob/main/repos-github.md.

nafg · 2022-10-03T20:43:16Z

What was the reason for disabling it?

xuwei-k mentioned this pull request Nov 25, 2020

Use GitHub to install Scala steward in a repo #102

Closed

xuwei-k commented Nov 25, 2020

View reviewed changes

project/Dependencies.scala Show resolved Hide resolved

fthomas reviewed Nov 27, 2020

View reviewed changes

xuwei-k force-pushed the github-app branch from f87b1be to b2743f7 Compare November 28, 2020 14:24

support GitHub Apps

80de957

xuwei-k force-pushed the github-app branch from b2743f7 to 80de957 Compare November 28, 2020 14:40

fthomas approved these changes Nov 28, 2020

View reviewed changes

fthomas added the enhancement New feature or request label Nov 28, 2020

fthomas added this to the 0.9.0 milestone Nov 28, 2020

fthomas merged commit 2253604 into scala-steward-org:master Nov 28, 2020

xuwei-k deleted the github-app branch November 30, 2020 03:41

xuwei-k commented Dec 1, 2020

View reviewed changes

laughedelic mentioned this pull request Mar 10, 2021

Support listing repositories via a Github App scala-steward-org/scala-steward-action#222

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

support GitHub Apps #1766

support GitHub Apps #1766

xuwei-k commented Nov 25, 2020 •

edited

Loading

codecov bot commented Nov 25, 2020 •

edited

Loading

xuwei-k commented Nov 26, 2020

fthomas commented Nov 26, 2020 •

edited

Loading

xuwei-k commented Nov 26, 2020

fthomas left a comment

fthomas Nov 27, 2020

fthomas Nov 27, 2020

laughedelic commented Nov 29, 2020

fthomas commented Nov 30, 2020

fthomas commented Nov 30, 2020

xuwei-k Dec 1, 2020

fthomas commented Sep 20, 2021

nafg commented Oct 3, 2022

support GitHub Apps #1766

support GitHub Apps #1766

Conversation

xuwei-k commented Nov 25, 2020 • edited Loading

How to use

1. create GitHub App

GitHub App name set some appropriate name. e.g. scala-steward-app ?

Homepage URL set some appropriate url. e.g. https://github.com/scala-steward-org ?

not require Webhook

use Metadata Read-only permission only

select Any account

2. Generate and save Private Key

3. Install

4. run

codecov bot commented Nov 25, 2020 • edited Loading

Codecov Report

xuwei-k commented Nov 26, 2020

fthomas commented Nov 26, 2020 • edited Loading

xuwei-k commented Nov 26, 2020

fthomas left a comment

Choose a reason for hiding this comment

fthomas Nov 27, 2020

Choose a reason for hiding this comment

fthomas Nov 27, 2020

Choose a reason for hiding this comment

laughedelic commented Nov 29, 2020

fthomas commented Nov 30, 2020

fthomas commented Nov 30, 2020

xuwei-k Dec 1, 2020

Choose a reason for hiding this comment

fthomas commented Sep 20, 2021

nafg commented Oct 3, 2022

xuwei-k commented Nov 25, 2020 •

edited

Loading

1. create `GitHub App`

`GitHub App name` set some appropriate name. e.g. `scala-steward-app` ?

`Homepage URL` set some appropriate url. e.g. `https://github.com/scala-steward-org` ?

not require `Webhook`

use `Metadata` `Read-only` permission only

select `Any account`

2. Generate and save `Private Key`

codecov bot commented Nov 25, 2020 •

edited

Loading

fthomas commented Nov 26, 2020 •

edited

Loading