mirror of
https://github.com/zhigang1992/probot.github.io.git
synced 2026-01-12 22:49:53 +08:00
107 lines
3.5 KiB
Markdown
107 lines
3.5 KiB
Markdown
---
|
|
title: Settings
|
|
description: Pull Requests for repository settings
|
|
slug: settings
|
|
stars: 227
|
|
authors:
|
|
- bkeepers
|
|
repository: probot/settings
|
|
screenshots:
|
|
- https://user-images.githubusercontent.com/173/29472917-3fad9db0-841b-11e7-8f6d-a6c63052122b.png
|
|
updated: 2018-08-11 00:10:47 UTC
|
|
host: https://github-configurer.herokuapp.com
|
|
installations: 178
|
|
organizations:
|
|
- apollographql
|
|
- denysdovhan
|
|
- bkeepers
|
|
- chaijs
|
|
- wp-cli
|
|
- probot
|
|
- benbalter
|
|
- tweag
|
|
- Anahkiasen
|
|
- TGMPA
|
|
---
|
|
|
|
This GitHub App syncs repository settings defined in `.github/settings.yml` to GitHub, enabling Pull Requests for repository settings.
|
|
|
|
## Usage
|
|
|
|
1. **[Install the app](https://github.com/apps/settings/installations/new)**.
|
|
2. Create a `.github/settings.yml` file in your repository. Changes to this file on the default branch will be synced to GitHub.
|
|
|
|
All settings are optional.
|
|
|
|
```yaml
|
|
repository:
|
|
# See https://developer.github.com/v3/repos/#edit for all available settings.
|
|
|
|
# The name of the repository. Changing this will rename the repository
|
|
name: repo-name
|
|
|
|
# A short description of the repository that will show up on GitHub
|
|
description: description of repo
|
|
|
|
# A URL with more information about the repository
|
|
homepage: https://example.github.io/
|
|
|
|
# Either `true` to make the repository private, or `false` to make it public.
|
|
private: false
|
|
|
|
# Either `true` to enable issues for this repository, `false` to disable them.
|
|
has_issues: true
|
|
|
|
# Either `true` to enable the wiki for this repository, `false` to disable it.
|
|
has_wiki: true
|
|
|
|
# Either `true` to enable downloads for this repository, `false` to disable them.
|
|
has_downloads: true
|
|
|
|
# Updates the default branch for this repository.
|
|
default_branch: master
|
|
|
|
# Either `true` to allow squash-merging pull requests, or `false` to prevent
|
|
# squash-merging.
|
|
allow_squash_merge: true
|
|
|
|
# Either `true` to allow merging pull requests with a merge commit, or `false`
|
|
# to prevent merging pull requests with merge commits.
|
|
allow_merge_commit: true
|
|
|
|
# Either `true` to allow rebase-merging pull requests, or `false` to prevent
|
|
# rebase-merging.
|
|
allow_rebase_merge: true
|
|
|
|
# Labels: define labels for Issues and Pull Requests
|
|
labels:
|
|
- name: bug
|
|
color: CC0000
|
|
- name: feature
|
|
color: 336699
|
|
- name: first-timers-only
|
|
# include the old name to rename and existing label
|
|
oldname: Help Wanted
|
|
|
|
# Collaborators: give specific users access to this repository.
|
|
collaborators:
|
|
- 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
|
|
|
|
- username:
|
|
permission: pull
|
|
|
|
```
|
|
|
|
**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 the 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.
|
|
|
|
This app is open source. Check out [probot/settings](https://github.com/probot/settings) to suggest improvements or run your own instance.
|