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

Improve experience when using a GitHub App #428

Merged
merged 11 commits into from
Dec 16, 2022

Conversation

alejandrohdezma
Copy link
Member

💻 How to review this PR?

This PR was created with the idea of being reviewed commit by commit. Each commit contains an incremental change that makes it easier to review. Also some of the commits contain additional information in their description to help understand why the change was made.

I also recommend checking "Hide whitespace" when reviewing this PR!

🚀 What does include this PR?

This PR adds two new inputs related to GitHub Apps:

  • github-app-installation-id: The ID of the installation where we want to run Scala Steward.
  • github-app-auth-only: If set to true the github-app-* inputs will only be used for authentication purposes, not for getting the list of repositories to update.

As part of this change, if a user provides the github-app-installation-id input, the GitHub App Token will be directly retrieved by this action, making the Generate token step on this guide obsolete.

🧑‍💻 Subsequent work

A full documentation revamp will be performed in a subsequent PR.

@alejandrohdezma alejandrohdezma requested a review from a team December 14, 2022 09:30
@github-actions
Copy link
Contributor

A snapshot release has been created as snapshots/428.

You can test it out with:

uses: scala-steward-org/scala-steward-action@snapshots/428

It will be automatically recreated on any change to this PR.

github-actions bot added a commit that referenced this pull request Dec 16, 2022
Base automatically changed from feature/improvements to master December 16, 2022 13:05
github-actions bot added a commit that referenced this pull request Dec 16, 2022
@github-actions
Copy link
Contributor

A snapshot release has been created as snapshots/428.

You can test it out with:

uses: scala-steward-org/scala-steward-action@snapshots/428

It will be automatically recreated on any change to this PR.

github-actions bot added a commit that referenced this pull request Dec 16, 2022
@alejandrohdezma alejandrohdezma merged commit 6394e4a into master Dec 16, 2022
@alejandrohdezma alejandrohdezma deleted the feature/github-app-installation branch December 16, 2022 15:42
rtyley added a commit to guardian/scala-steward-public-repos that referenced this pull request Jun 2, 2023
Working on #44 -
now that scala-steward-org/scala-steward-action#428
updated the Scala Steward GitHub Action to have its _own_ support for
GitHub App authentication, we can remove the additional 'Generate token'
step from our GitHub Action workflow, with these benefits:

* No longer need to use the tibdex/github-app-token - one fewer action
  we need to trust
* In a subsequent step, we may be able to remove the necessity of
  adding repos to `REPOSITORIES.md` - as, so far as I can see, the GitHub
  Action will now automatically run on all repos we install it on, without
  having to also add them to `REPOSITORIES.md`:
  https://github.com/scala-steward-org/scala-steward/blob/113884ac11d639ed8b70fc368f6a69895b14f8ba/modules/core/src/main/scala/org/scalasteward/core/application/StewardAlg.scala#L97-L98
rtyley added a commit to guardian/scala-steward-public-repos that referenced this pull request Jun 2, 2023
Working on #44 -
now that scala-steward-org/scala-steward-action#428
updated the Scala Steward GitHub Action to have its _own_ support for
GitHub App authentication, we can remove the additional 'Generate token'
step from our GitHub Action workflow, with these benefits:

* No longer need to use the tibdex/github-app-token - one fewer action
  we need to trust!
* Running the Scala Steward action on a repo no longer requires adding the
  repo to REPOSITORIES.md - only granting the installation access to the
  repo is required.
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

Successfully merging this pull request may close these issues.

2 participants