Skip to content
This repository was 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

Merged
merged 4 commits into from
Feb 2, 2023
Merged

Added how repo is selected section in README and other minor FAQs #49

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7686d6d
Added how repo is selected section in README
t-dedah Jan 23, 2023
44cd99d
minor
t-dedah Feb 1, 2023
9c6e5bf
minor
t-dedah Feb 1, 2023
53f5987
Update README.md
t-dedah Feb 2, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Contributor

Choose a reason for hiding this comment

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

Should this be put under a generic section for FAQ or troubleshooting?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Added under FAQs

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.
Copy link
Contributor

Choose a reason for hiding this comment

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

For my learning - what is special about upstream and github remotes. origin is the default remote, isn't it?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

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

Copy link
Contributor

Choose a reason for hiding this comment

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

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Separated the line as next paragraph


## Contributing
If anything feels off, or if you feel that some functionality is missing, please check out the [contributing page](CONTRIBUTING.md). There you will find instructions for sharing your feedback, building the tool locally, and submitting pull requests to the project.