Skip to content

Update readme to include go-githubauth for Application auth#3180

Merged
gmlewis merged 3 commits intogoogle:masterfrom
jferrl:jferrl-3178
Jun 1, 2024
Merged

Update readme to include go-githubauth for Application auth#3180
gmlewis merged 3 commits intogoogle:masterfrom
jferrl:jferrl-3178

Conversation

@jferrl
Copy link
Copy Markdown
Contributor

@jferrl jferrl commented Jun 1, 2024

Fixes: #3178.

This PR includes some README changes to include references of a new pkg to authenticate application and installation requests.

@codecov
Copy link
Copy Markdown

codecov bot commented Jun 1, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.93%. Comparing base (2b8c7fa) to head (b2717c0).
Report is 66 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #3180      +/-   ##
==========================================
- Coverage   97.72%   92.93%   -4.79%     
==========================================
  Files         153      171      +18     
  Lines       13390    11542    -1848     
==========================================
- Hits        13085    10727    -2358     
- Misses        215      724     +509     
- Partials       90       91       +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

README.md Outdated
return
}

installationTokenSource := githubauth.NewInstallationTokenSource(20, appTokenSource)
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

According to this: https://github.com/jferrl/go-githubauth/blob/main/auth.go#L52
the first argument is id string so the 20 here looks weird.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've updated the code to be aligned with go-github ids representation. Now both ids are defined as int64. Also changed the readme go code examples.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just FYI - your README.md still needs to be updated - not a biggie - just wanted to let you know. 😄
https://github.com/jferrl/go-githubauth/blob/main/README.md?plain=1#L48-L51

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure! Im working on it! thanks!

@jferrl jferrl requested a review from gmlewis June 1, 2024 22:14
Copy link
Copy Markdown
Collaborator

@gmlewis gmlewis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you, @jferrl !
LGTM.
Merging.

@gmlewis gmlewis merged commit 446a296 into google:master Jun 1, 2024
@jferrl jferrl deleted the jferrl-3178 branch June 1, 2024 22:23
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.

Proposal: Add GitHub App Token and Installation Token Source Functionality

2 participants