From fc687f898b0b6ee29f0da13f5c1283f43c4d9b0a Mon Sep 17 00:00:00 2001 From: Peter Evans Date: Tue, 25 Aug 2020 12:18:25 +0900 Subject: [PATCH] docs: update examples --- docs/examples.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/examples.md b/docs/examples.md index 0a18871..742a26f 100644 --- a/docs/examples.md +++ b/docs/examples.md @@ -279,7 +279,8 @@ jobs: ### Keep a fork up-to-date with its upstream -This example should not be run in the fork itself because committing anything to the fork's default branch would cause it to differ from the upstream. Create a new repository where this workflow will run. +This example is designed to be run in a seperate repository from the fork repository itself. +The aim of this is to prevent committing anything to the fork's default branch would cause it to differ from the upstream. In the following example workflow, `owner/repo` is the upstream repository and `fork-owner/repo` is the fork. It assumes the default branch of the upstream repository is called `master`.