feat(releaser): add support for custom krew index repo #76
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rajatjindal
reviewed
Dec 1, 2024
pkg/krew/repos.go
Outdated
| @@ -9,7 +9,7 @@ const ( | |||
|
|
|||
| //GetKrewIndexRepoName returns the krew-index repo name | |||
| func GetKrewIndexRepoName() string { | |||
| override := os.Getenv("UPSTREAM_KREW_INDEX_REPO_NAME") | |||
| override := os.Getenv("INPUT_UPSTREAM_KREW_INDEX_REPO_NAME") | |||
There was a problem hiding this comment.
this code actually runs on server side (IIRC), and do not have access to the GitHub inputs. what we will have to do is to accept this input, and then pass along this info to the backend as part of request.
the backend then needs to consider 3 scenarios:
- The override configured on server side. this should take preference over GitHub action input and defaults, as this helps with testing the server.
- The override configured as part of GitHub action (if no override provided on server side)
- The default values. (if no override provided at all)
There was a problem hiding this comment.
hi @rajatjindal, thank you so much for the feedback! I have implemented the changes, and the PR should now be updated.
Please let me know if anything else needs to be changed, or if I am missing anything. 😄
rajatjindal
reviewed
Dec 1, 2024
pkg/krew/repos.go
Outdated
| @@ -19,7 +19,7 @@ func GetKrewIndexRepoName() string { | |||
|
|
|||
| //GetKrewIndexRepoOwner returns the krew-index repo owner | |||
| func GetKrewIndexRepoOwner() string { | |||
| override := os.Getenv("UPSTREAM_KREW_INDEX_REPO_OWNER") | |||
| override := os.Getenv("INPUT_UPSTREAM_KREW_INDEX_REPO_OWNER") | |||
rajatjindal
reviewed
Dec 1, 2024
pkg/releaser/git.go
Outdated
| ts := oauth2.StaticTokenSource(&oauth2.Token{AccessToken: r.Token}) | ||
| tc := oauth2.NewClient(context.TODO(), ts) | ||
| client := github.NewClient(tc) | ||
| client := getGitHubClient(r.Token) |
There was a problem hiding this comment.
maybe have a client on Releaser object and just reuse that instead of creating here and in clonerepo function.
also it seems like could needs indentation.
Thank you @rajatjindal for the feeback. I have made a few changes based on that feeback. Some of the updates are listed below: - updated Releaser object to have a client - add logic to accept custom krew-index input through GitHub Action - add logic to pass input to the backend server as part of the request - add precedence for krew-index values with server side override having highest priority - ran "go fmt ./..." - ran "go vet ./..." Signed-off-by: Casale, Robert <robert.casale@fmr.com>
kayhern
force-pushed
the
fix-issue-47
branch
from
8658a41 to
92c9833
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR is to allow users to provide a custom
krew-indexrepository, in case they do not wish to upload to the publickrew-indexrepository.The goal is to allow users to provide the custom
krew-indexrepository information through two new parameters:upstream_krew_index_repo_ownerupstream_krew_index_repo_nameThe GitHub Action will then determine the
defaultbranch that is configured for the customkrew-indexrepository, and create a PR against thatdefaultbranch. Just in case the customkrew-indexrepository does not use themasterbranch.This is very helpful for organizations that are hosting their own internal
krew-indexrepositories, and allows them to automate their release cycles.Fixes
#47
Please let me know if there is anything else I might be missing. 😄