feat(wsl-checkout): Add support for checking out a private repository into WSL #517
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.
This PR adds support for checkout out a private repository into WSL by utilizing a GitHub token.
Note that the token persists in the git config even after the action completes. Since we aren't using a JavaScript action, we don't have the ability to cleanup the token in the git configuration at the end. Additionally, clearing the git configuration at the end of the main action would cause a change in behavior down the road between private and public repositories at best, and a breaking behavior change at worst. Thus, we only just warn the user in the description, and by default not use any token at all.
As a consequence, one should only be using this feature in tightly controlled environments such as self-hosted runners and should also use scoped permissions. Presently, the existing e2e tests only handle the non-token case for this reason.
Realistically, we should probably overhaul many of these actions to be more robust at some point.