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

Update README.md #1

Merged
merged 1 commit into from
Apr 6, 2022
+6 −6
Merged

Update README.md #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
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