Skip to content

Commit

Permalink
doc: Added detailed tutorial to set up “overwrite-github” direction, #9
Browse files Browse the repository at this point in the history
Signed-off-by: Jaid <jaid.jsx@gmail.com>
  • Loading branch information
Jaid committed May 24, 2021
1 parent 37a435c commit 4c1ca87
Showing 1 changed file with 40 additions and 2 deletions.
42 changes: 40 additions & 2 deletions readme/example.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,8 +59,46 @@ jobs:

<details>
<summary>Detailed setup</summary>
Go to your account settings.
Go to your account settings and then to “Developer settings”.

![Step 1](readme/tokenSteps/01.png)
![Token setup: Step 1](readme/tokenSteps/01.png)

Go to “Personal access tokens”.

![Token setup: Step 2](readme/tokenSteps/02.png)

Click “Generate new token”.

![Token setup: Step 3](readme/tokenSteps/03.png)

Give it a good title, so you still know what your token does in one year. Add „repo“ permissions.

![Token setup: Step 4](readme/tokenSteps/04.png)

Copy the generated token.

![Token setup: Step 5](readme/tokenSteps/05.png)

Go to the repository that uses action-sync-node-meta. Go to “Settings”, “Secrets”.

![Token setup: Step 6](readme/tokenSteps/06.png)

Click “New repository secret”.

![Token setup: Step 7](readme/tokenSteps/07.png)

Add the secret token from your clipboard. Name the token “repoGithubToken” or anything you like.

![Token setup: Step 8](readme/tokenSteps/08.png)

Now pass the token to action-sync-node-meta in your workflow file.

```yaml
- name: Jaid/action-sync-node-meta
uses: jaid/action-sync-node-meta@v1.4.0
with:
direction: overwrite-github
githubToken: ${{ secrets.“repoGithubToken” }}
```

</details>

0 comments on commit 4c1ca87

Please sign in to comment.