3. Set up Automatic Updates

Now that you have your own fork of the Rewst documentation repo, you'll want to be sure to keep it up to date with the upstream repo. GitHub won't automatically pull those updates down for you. That's where the GitHub App Pull comes in.

1

Install Pull

Pull GitHub App page

It'll prompt you to sign in to GitHub again and if your GitHub user is a member of an organization, you'll have the option of installing to your user account or (if you are an admin of the organization) to the organization.

2

Select "All repositories" or "Only select repositories"

Depending on your GitHub usage, you may have projects that you only want to manually update. This will determine how you configure Pull.

3

Click Install

4

Create pull configuration file

The default for Pull is to create a pull request that you manually need to merge. For something like staying up to date on changes to the upstream repo, you'll want to tweak this so that changes automatically merge to your repo.

On your fork of the docs site, click "Add file" and then "+ Create new file"

In the "Name your file..." window type .github/pull.yml for the file's name.

Inclusion of the .github/ is important. This will create a folder called .github that the Pull GitHub App looks to for any update settings. Depending on the project and your use of the repository, not placing the file here could cause application deployment issues since this folder will be bypassed during Build and Deploy jobs.

The contents of that file should be:

version: "1"
rules:
  - base: main
    upstream: RewstApp:main
    mergeMethod: merge

The mergeMethod is what instructs Pull to automatically merge changes from the upstream repo into yours.

Commit those changes to your main branch.

Pull will now automatically update your branch of the Rewst docs when the Rewst team publishes new updates!