This repository has been archived by the owner on Oct 21, 2024. It is now read-only.
Added how repo is selected section in README and other minor FAQs #49
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
README.md
Outdated
| @@ -97,6 +97,8 @@ EXAMPLES: | |||
|
|
|||
| > ℹ️ There could be multiple caches in a repo with same key. This can happen when different caches with same key have been created for different branches. it may also happen if the `version` property of the cache is different which usually means that cache with same key was created for different OS or with different [paths](https://github.com/actions/cache#inputs). | |||
|
|
|||
| ## How Repo is selected | |||
There was a problem hiding this comment.
Should this be put under a generic section for FAQ or troubleshooting?
README.md
Outdated
| @@ -97,6 +97,8 @@ EXAMPLES: | |||
|
|
|||
| > ℹ️ There could be multiple caches in a repo with same key. This can happen when different caches with same key have been created for different branches. it may also happen if the `version` property of the cache is different which usually means that cache with same key was created for different OS or with different [paths](https://github.com/actions/cache#inputs). | |||
|
|
|||
| ## How Repo is selected | |||
| This extension currently uses the `go-gh` module's [`CurrentRepository` function](https://github.com/actions/gh-actions-cache/blob/d3293b69e1c5bc17686d815ab2c64618618c95df/internal/utils.go#L26) to determine the current repo. This function returns the first element of the list returned by the `git.Remotes()` internal function, which [sorts remotes such that `upstream` precedes `github`, which precedes `origin`](https://github.com/cli/go-gh/blob/c2fc965daac88a8a38dd8af02f236095b5dd48f1/internal/git/remote.go#L30). As such, if an `upstream` remote is present, this extension's default behavior is to return its caches. User's input `--repo <owner>/<name>` will override any current git repository and extension will fetch caches for the same. | |||
There was a problem hiding this comment.
For my learning - what is special about upstream and github remotes. origin is the default remote, isn't it?
There was a problem hiding this comment.
origin is the source for the current repo. So in case of forks origin will point to the fork's origin. In order to keep track between original and forked repo, we generally set a new remote upstream to the original repo. Now we can use git fetch upstream to sync forked and original repo. I am not sure about github remote
README.md
Outdated
| @@ -97,6 +97,8 @@ EXAMPLES: | |||
|
|
|||
| > ℹ️ There could be multiple caches in a repo with same key. This can happen when different caches with same key have been created for different branches. it may also happen if the `version` property of the cache is different which usually means that cache with same key was created for different OS or with different [paths](https://github.com/actions/cache#inputs). | |||
|
|
|||
| ## How Repo is selected | |||
| This extension currently uses the `go-gh` module's [`CurrentRepository` function](https://github.com/actions/gh-actions-cache/blob/d3293b69e1c5bc17686d815ab2c64618618c95df/internal/utils.go#L26) to determine the current repo. This function returns the first element of the list returned by the `git.Remotes()` internal function, which [sorts remotes such that `upstream` precedes `github`, which precedes `origin`](https://github.com/cli/go-gh/blob/c2fc965daac88a8a38dd8af02f236095b5dd48f1/internal/git/remote.go#L30). As such, if an `upstream` remote is present, this extension's default behavior is to return its caches. User's input `--repo <owner>/<name>` will override any current git repository and extension will fetch caches for the same. | |||
There was a problem hiding this comment.
User's input
--repo <owner>/<name>will override any current git repository and extension will fetch caches for the same.
Is this sentence related to rest of paragraph? Or can be a separate para.
There was a problem hiding this comment.
Separated the line as next paragraph
t-dedah
changed the title
bishal-pdMSFT
approved these changes
Feb 2, 2023
Co-authored-by: Bishal Prasad <[email protected]>
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
What are you trying to accomplish?
Fix this issue #36
What approach did you choose and why?
Anything you want to highlight for special attention from reviewers?