Brian's Integration and Automation Notes
  • Welcome!
  • Allow Me to Brag a Bit
  • About
  • Integrations
    • ConnectWise Home
      • Authentication
      • API Documentation
  • Automations
    • Teams Notifications Azure Bot
      • Acknowledgement
      • Considerations
      • The Basics/Getting Started
        • Create a Response Handler Workflow in Rewst
        • Getting the IDs from Teams
      • Two Stage Message Process
        • Formatting the Initial Message
        • Getting the Message IDs
        • Formatting the Message Update
      • Formatting Action Buttons
        • Approve/Deny
        • Assign Resource to Ticket
      • Working with the Responses
      • System Incident/Maintance Notifications
        • Admitting Defeat on the Database
        • The Workflow Structure
      • Resources
    • Automated GitHub/GitBook Update Notifications
      • Prerequisites
      • 1. Set up a Basic Workflow
      • 2. Fork the GitHub Repository
      • 3. Set up Automatic Updates
      • 4. Set up notifications in GitHub
      • 5. Set up Remaining Workflow Actions
  • ConnectWise PSA Actions
    • About
    • Assigning Resources to Tickets
    • Ticket Assignment Note
    • Unbundle Ticket
    • Sales Activity Assignment Note
Powered by GitBook
On this page
  1. Automations
  2. Automated GitHub/GitBook Update Notifications

3. Set up Automatic Updates

Previous2. Fork the GitHub RepositoryNext4. Set up notifications in GitHub

Last updated 1 month ago

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

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!

Pull GitHub App page