-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add: Documentation for git-use-https Action
- Loading branch information
1 parent
ea39092
commit 97d7e02
Showing
1 changed file
with
26 additions
and
0 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
# Use HTTPS for Git data transfer | ||
|
||
GitHub Action to use Git over HTTPS with OAuth instead of SSH to transfer data to GitHub. This fixes cloning private GitHub repositories, when unable to use `actions/checkout`. | ||
|
||
#### Use Case | ||
|
||
```yaml | ||
jobs: | ||
build: | ||
name: Build | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v4 | ||
- name: "Use HTTPS for GitHub data transfer" | ||
uses: greenbone/actions/git-use-https@v3 | ||
with: | ||
token: ${{ secrets.GREENBONE_BOT_TOKEN }} | ||
- name: Setup Poetry with private GitHub repository as dependency | ||
uses: greenbone/actions/poetry@v3 | ||
``` | ||
|
||
## Action Configuration | ||
|
||
| Input Variable | Description | | | ||
| ----------------------- | ------------------------------------------------------------------------------- | -------- | | ||
| token | OAuth 2.0 token to use for authentication | Required | |