doc: Document forked repo config

williamdes · williamdes · commit 48c94d0d537b · 2020-04-05T02:23:11.000+02:00
diff --git a/README.md b/README.md
@@ -9,8 +9,9 @@ This action locks a pull-request
     uses: sudo-bot/action-fork-sync@v1.0.1
     with:
         branches: master, STABLE, next
-        source-url: "https://${{ secrets.BOT_TOKEN }}:x-oauth-basic@github.com/myname/myproject.git"
-        fork-url: "https://${{ secrets.BOT_TOKEN }}:x-oauth-basic@github.com/myname/myproject.git"
+        source-url: "https://${{ secrets.BOT_TOKEN }}:x-oauth-basic@github.com/orgname/officialproject.git"
+        # Give repo scope to token and access to myname/officialproject-fork for a token user != myname (eg: a bot)
+        fork-url: "https://${{ secrets.BOT_TOKEN }}:x-oauth-basic@github.com/myname/officialproject-fork.git"
         dry-run: "true" # remove this line to make sync effective
         clone-depth: "100" # optional, defaults to 100
 ```

-Original file line number
+Diff line change
     uses: sudo-bot/[email protected]
     with:
         branches: master, STABLE, next
 -        source-url: "https://${{ secrets.BOT_TOKEN }}:[email protected]/myname/myproject.git"
 -        fork-url: "https://${{ secrets.BOT_TOKEN }}:[email protected]/myname/myproject.git"
 +        source-url: "https://${{ secrets.BOT_TOKEN }}:[email protected]/orgname/officialproject.git"
 +        # Give repo scope to token and access to myname/officialproject-fork for a token user != myname (eg: a bot)
 +        fork-url: "https://${{ secrets.BOT_TOKEN }}:[email protected]/myname/officialproject-fork.git"
         dry-run: "true" # remove this line to make sync effective
         clone-depth: "100" # optional, defaults to 100
 ```