Repository files navigation

This GitHub App syncs repository settings defined in.github/settings.yml to GitHub, enabling Pull Requests for repository settings.

• Usage
  • Install
    • Hosted GitHub.com App
    • Self-Hosted App
  • Configuration
• Security Implications

To gain the benefits of the Repository Settings app, it will need to installedas a GitHub App on your repositories.First, choose which approach to using the Repository Settings App is most appropriate for you:

A hosted version is provided for use with GitHub.com.

Install the app on your repositories orentire organization.

If you would prefer to self-host your own instance, see the documentation aboutself-hosting if you would like to run your own instance of this app.

Now that you have the repository settings app installed for your repositories,see the documentation aboutconfiguration for detailsabout updating your repository settings through pull-requests.

One way to preserve admin/push permissions is to utilize theGitHub CodeOwners featureto set one or more administrative users as the code owner of the.github/settings.yml file, and turn on "require code owner review" for thedefault branch.This does have the side effect of requiring code owner review for the entirebranch, but helps preserve permission levels.