Skip to content
This repository has been archived by the owner on Apr 10, 2023. It is now read-only.

Commit

Permalink
Merge pull request #1 from caddijp/feature/readme
Browse files Browse the repository at this point in the history
  • Loading branch information
kei711 authored Apr 6, 2022
2 parents fe56d4d + d0ed0b4 commit 7de7ba6
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
# checkout-private-action
This action checkout your private repository using Github Apps.
You can use other private repository github actions code.
This action checkout your private repository using GitHub Apps.
You can use other private repository GitHub Actions code.

## Prerequirements

### Github Apps

To checkout private repository, you need to create [Github Apps](https://docs.github.com/en/developers/apps/getting-started-with-apps/about-apps), and install it in your orgnizaions.
This Github Apps need contents read permission.
To checkout private repository, you need to create [Github Apps](https://docs.github.com/en/developers/apps/getting-started-with-apps/about-apps), and install it in your organizations.
This GitHub Apps need contents read permission.

Then, you need to keep github apps id and private key. We reccommend to keep these in github actions secrets.
Then, you need to keep GitHub Apps ID and private key. We reccommend to keep these in GitHub Actions secrets.


## Usage
Expand All @@ -18,7 +18,7 @@ Then, you need to keep github apps id and private key. We reccommend to keep the
# .github/worlflows/example.yml
jobs:
eample:
example:
# Assumed to run on ubuntu
runs-on: ubuntu-latest
...
Expand Down

0 comments on commit 7de7ba6

Please sign in to comment.