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

Document that an application is not required #617

Closed
SpecialThing44 opened this issue Jul 8, 2024 · 0 comments · Fixed by #618
Closed

Document that an application is not required #617

SpecialThing44 opened this issue Jul 8, 2024 · 0 comments · Fixed by #618

Comments

@SpecialThing44
Copy link
Contributor

To use the Action in your repo, you need to create a GitHub App. Then you need to create a new GitHub Actions workflow file to run this Action. Here is a step-by-step tutorial on how to do it:
This is inaccurate. I have successfully ran this action without one, which is demonstrated in https://github.com/SpecialThing44/scala-steward-action-test.

If you remove the below lines from the workflow file:

with:
  github-app-id: ${{ secrets.APP_ID }}
  github-app-installation-id: ${{ secrets.APP_INSTALLATION_ID }}
  github-app-key: ${{ secrets.APP_PRIVATE_KEY }}

Add write permissions as such at the top level:

permissions:
  contents: write
  pull-requests: write

and ensure that GitHub Actions has permissions to create and approve pull requests:
At /<repo_name>/settings/actions for users
At /<organization_name>/settings/actions for organizations.

Then you can use this action without having to create an app or any related secrets.

In general this is nice because it saves a lot of time, and avoids having to maintain secrets and apps with permissions.

As an added bonus, it works in forks.

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 a pull request may close this issue.

1 participant