Skip to content

Commit

Permalink
Add: Documentation for git-use-https Action
Browse files Browse the repository at this point in the history
  • Loading branch information
n-thumann authored and greenbonebot committed Feb 12, 2024
1 parent ea39092 commit 97d7e02
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions git-use-https/README.md
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 |

0 comments on commit 97d7e02

Please sign in to comment.