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 installing as Oauth app #2498

Closed
4 tasks done
runephilosof-karnovgroup opened this issue Sep 25, 2023 · 1 comment · Fixed by #2499
Closed
4 tasks done

Document installing as Oauth app #2498

runephilosof-karnovgroup opened this issue Sep 25, 2023 · 1 comment · Fixed by #2499
Labels
bug Something isn't working documentation docu & docs forge/github github forge related

Comments

@runephilosof-karnovgroup
Copy link
Contributor

runephilosof-karnovgroup commented Sep 25, 2023

Clear and concise description of the problem

#2482 (reply in thread)

We use the GH app as described in the docs.

The Woodpecker docs does not mention whether to create Woodpecker as a Github App or as an Oauth app.
It does not seem like tokens need to be refreshed, if installed as an Oauth app. The Github docs does not mention refreshing Oauth token https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/authenticating-to-the-rest-api-with-an-oauth-app#implementing-persistent-authentication.

Update to that...
The next documentation tells admins to install as a Github App. I don't think Woodpecker is ready for that. It needs more token handling for that.

Suggested solution

https://woodpecker-ci.org/docs/administration/forges/github#registration should tell admins to set it up as an Oauth App, not a Github App.
Also, update the screenshot.

Alternative

No response

Additional context

The instructions to install as a Github App were merged here #2472

Validations

  • Checked that the feature isn't part of the next version already [https://woodpecker-ci.org/faq#which-version-of-woodpecker-should-i-use]
  • Read the Contributing Guidelines.
  • Read the docs.
  • Check that there isn't already an issue that request the same feature to avoid creating a duplicate.
@runephilosof-karnovgroup runephilosof-karnovgroup added the feature add new functionality label Sep 25, 2023
@pat-s
Copy link
Contributor

pat-s commented Sep 25, 2023

Thanks, that is helpful! I've issued #2472 and will provide an update. Though the instructions before weren't specific on this either.

But yes, this could be the reason for the issues reported in #2488.

@pat-s pat-s added bug Something isn't working documentation docu & docs forge/github github forge related and removed feature add new functionality labels Sep 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation docu & docs forge/github github forge related
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants