-
Notifications
You must be signed in to change notification settings - Fork 111
Add git insteadof
example
#273
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
multimeric
wants to merge
2
commits into
actions:main
Choose a base branch
from
multimeric:insteadof-example
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -296,6 +296,44 @@ jobs: | |||||
GITHUB_TOKEN: ${{ steps.create_token.outputs.token }} | ||||||
``` | ||||||
|
||||||
### Tell git to use the app token to authenticate | ||||||
|
||||||
Certain tools use `git` to access repositories, but have no facility to accept a GitHub API token. | ||||||
In this scenario it's easier to configure `git` itself to use the token. | ||||||
For example, this is important if you have a Python project with a `git+https` or a `git+ssh` dependency on a private repository. | ||||||
|
||||||
```yaml | ||||||
on: [pull_request] | ||||||
|
||||||
jobs: | ||||||
python-build: | ||||||
runs-on: ubuntu-latest | ||||||
steps: | ||||||
- uses: actions/create-github-app-token@v2 | ||||||
id: app-token | ||||||
with: | ||||||
# required | ||||||
app-id: ${{ vars.APP_ID }} | ||||||
private-key: ${{ secrets.PRIVATE_KEY }} | ||||||
- name: Configure git to use the app token | ||||||
run: git config --global url."https://USERNAME:${GITHUB_TOKEN}@github.com/".insteadOf "https://github.com/" | ||||||
env: | ||||||
GITHUB_TOKEN: ${{ steps.app-token.outputs.token }} | ||||||
- uses: actions/setup-python@v5 | ||||||
- name: Install dependencies | ||||||
run: pip install . | ||||||
``` | ||||||
|
||||||
Refer to [`git`'s configuration docs](https://git-scm.com/docs/git-config#Documentation/git-config.txt-urlbaseinsteadOf) for more information on this syntax. | ||||||
|
||||||
In this example, `USERNAME` is ignored by GitHub since the token contains the full authentication information. For this reason, you can leave it in the configuration as is. | ||||||
|
||||||
The above example will use the same token for all `git` operations on GitHub via `https`, but you can configure it on a per repository or per-organisation basis by changing the prefix: | ||||||
|
||||||
```bash | ||||||
git config --global url."https://USERNAME:${GITHUB_TOKEN}@github.com/MyOrg/MyRepo".insteadOf "https://github.com/MyOrg/MyRepo" | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This example uses the same unexplained 'USERNAME' placeholder. For consistency and clarity, this should match the explanation provided for the main example above.
Suggested change
Copilot uses AI. Check for mistakes. Positive FeedbackNegative Feedback |
||||||
``` | ||||||
|
||||||
## Inputs | ||||||
|
||||||
### `app-id` | ||||||
|
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The placeholder 'USERNAME' in the Git URL is not explained. Consider clarifying what value should be used here or if it's a literal placeholder that Git ignores for token-based authentication.
Copilot uses AI. Check for mistakes.