Skip to content

Commit

Permalink
Improve the documentation for basic repos
Browse files Browse the repository at this point in the history
  • Loading branch information
qcastel committed Feb 9, 2022
1 parent 33a7c56 commit 62a22ba
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -135,10 +135,14 @@ If you are concerned about the security of this github action, you can also move
For a simple repo with not much protection and private dependency, you can do:

```yaml
env:
JAVA_HOME: /usr/lib/jvm/java-17-openjdk/
with:
access-token: ${{ secrets.GITHUB_ACCESS_TOKEN }}
ssh-private-key: ${{ secrets.SSH_PRIVATE_KEY }}
```
You will need to follow the `Setup with SSH` section to setup the `SSH_PRIVATE_KEY` accordingly.

### Setup with SSH

Although you may found better to use a SSH key instead. For this, generate an SSH key with the method of your choice, or use an existing one.
Expand Down

0 comments on commit 62a22ba

Please sign in to comment.