Skip to content

Latest commit

 

History

History
34 lines (21 loc) · 1.81 KB

README.md

File metadata and controls

34 lines (21 loc) · 1.81 KB

Getting Started 🐙

Welcome to GERP! We hope you love this tool as much as we do. Refer to the gerp repo for more documentation.

Copy Template Repo 📄

This repo is a template, and you can duplicate it to get a quick and easy setup.

Click Here to use this repo template, or hit the Use This Template button at the top.

Configuration 🔧

After duplicating, add the following secrets to your repository then you're good to go 😃.

required secrets:
  PAT

// Your PAT will need the following permissions depending on your target repos and desired templates
repo.public_repo   // Required to make PRs against target repos
repo               // Only needed if you are synchronizing priviate repos
workflow           // Only needed if you are synchronizing anything in the .github directory 

To add a target repo, just add it to your gerp config

Files placed in the /template directory will be synced into the root of target directories. Variables can be substituted using mustache templating, with inputs provided in your gerp config. Inputs from your gerp config are applied on a per-repo basis to all files being synced.

Synchronization will occur when a change is merged into the main branch. Progress can be seen in the Actions tab.

Terms 📚

Template Repo: The source of truth repository that GERP will use to determine which files to sync

Target Repo: A repository that GERP will open pull pull requests against in order to reconcile its files based on the template repository