From 3c4d1e7c2ed831176e94633725cf677fd0d40e22 Mon Sep 17 00:00:00 2001 From: Jaid Date: Wed, 29 Apr 2020 22:26:45 +0200 Subject: [PATCH] docs: Updated readme source --- readme/example.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/readme/example.md b/readme/example.md index dee2961..d59c073 100644 --- a/readme/example.md +++ b/readme/example.md @@ -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 @@ -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 }} ``` @@ -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 }}