Name: settings
Owner: Probot
Description: Pull Requests for GitHub repository settings
Created: 2017-01-22 17:33:36.0
Updated: 2018-05-24 12:45:47.0
Pushed: 2018-05-19 13:33:44.0
Homepage: https://github.com/apps/settings
Size: 210
Language: JavaScript
GitHub Committers
| User | Most Recent Commit | # Commits |
|---|
Other Committers
| User | Most Recent Commit | # Commits |
|---|
This GitHub App syncs repository settings defined in .github/settings.yml to GitHub, enabling Pull Requests for repository settings.
.github/settings.yml file in your repository. Changes to this file on the default branch will be synced to GitHub.All settings are optional.
ese settings are synced to GitHub by https://probot.github.io/apps/settings/
sitory:
See https://developer.github.com/v3/repos/#edit for all available settings.
The name of the repository. Changing this will rename the repository
me: repo-name
A short description of the repository that will show up on GitHub
scription: description of repo
A URL with more information about the repository
mepage: https://example.github.io/
A comma-separated list of topics to set on the repository
pics: github, probot
Either `true` to make the repository private, or `false` to make it public.
ivate: false
Either `true` to enable issues for this repository, `false` to disable them.
s_issues: true
Either `true` to enable projects for this repository, or `false` to disable them.
If projects are disabled for the organization, passing `true` will cause an API error.
s_projects: true
Either `true` to enable the wiki for this repository, `false` to disable it.
s_wiki: true
Either `true` to enable downloads for this repository, `false` to disable them.
s_downloads: true
Updates the default branch for this repository.
fault_branch: master
Either `true` to allow squash-merging pull requests, or `false` to prevent
squash-merging.
low_squash_merge: true
Either `true` to allow merging pull requests with a merge commit, or `false`
to prevent merging pull requests with merge commits.
low_merge_commit: true
Either `true` to allow rebase-merging pull requests, or `false` to prevent
rebase-merging.
low_rebase_merge: true
bels: define labels for Issues and Pull Requests
ls:
name: bug
color: CC0000
name: feature
color: 336699
name: first-timers-only
# include the old name to rename an existing label
oldname: Help Wanted
llaborators: give specific users access to this repository.
aborators:
username: bkeepers
# Note: Only valid on organization-owned repositories.
# The permission to grant the collaborator. Can be one of:
# * `pull` - can pull, but not push to or administer this repository.
# * `push` - can pull and push, but not administer this repository.
# * `admin` - can pull, push and administer this repository.
permission: push
username: hubot
permission: pull
TE: The APIs needed for teams are not supported yet by GitHub Apps
tps://developer.github.com/v3/apps/available-endpoints/
s:
name: core
permission: admin
name: docs
permission: push
WARNING: Note that this app inherently escalates anyone with push permissions to the admin role, since they can push config settings to the master branch, which will be synced. In a future, we may add restrictions to allow changes to the config file to be merged only by specific people/teams, or those with admin access (via a combination of protected branches, required statuses, and branch restrictions). Until then, use caution when merging PRs and adding collaborators.
Until restrictions are added in this app, one way to preserve admin/push permissions is to utilize the GitHub CodeOwners feature to set one or more administrative users as the code owner of the .github/settings.yml file, and turn on “require code owner review” for the master branch. This does have the side effect of requiring code owner review for the entire branch, but helps preserve permission levels.
See docs/deploy.md if you would like to run your own instance of this plugin.