Skip to content

Commit

Permalink
docs: Updated readme source
Browse files Browse the repository at this point in the history
  • Loading branch information
Jaid committed Apr 29, 2020
1 parent 4843642 commit 3c4d1e7
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions readme/example.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
Example workflow that runs whenever commits are pushed on branch `master`.
This will overwrite the `package.json` file if it differs from the GitHub repository info.

This is the recommended syncing direction, because of the more simple setup (no need to manually add a secret to the repository settings) and the adventages of git commits (better monitoring, revertability).

`.github/workflows/example.yml`
```yaml
name: Sync package.json with repository info
Expand All @@ -20,7 +22,7 @@ jobs:
with:
node-version: "13.9.0"
- name: Jaid/action-sync-node-meta
uses: jaid/action-sync-node-meta@v1.3.0
uses: jaid/action-sync-node-meta@v1.4.0
with:
githubToken: ${{ secrets.GITHUB_TOKEN }}
```
Expand Down Expand Up @@ -49,7 +51,7 @@ jobs:
with:
node-version: "13.9.0"
- name: Jaid/action-sync-node-meta
uses: jaid/action-sync-node-meta@v1.0.0
uses: jaid/action-sync-node-meta@v1.4.0
with:
direction: overwrite-github
githubToken: ${{ secrets.customGithubToken }}
Expand Down

0 comments on commit 3c4d1e7

Please sign in to comment.