document behavior of settings in .github repository

[gr2m]

Problem Description

By creating a .github/settings.yml file in my central .github repository, I expected the settings would be applied to all repositories in the same organization

What is actually happening

The settings are only applied to the .github repository.

What is the expected behavior

The behavior is fine as is, I'd just suggest we document it

[tchupp]

Please document this!

Based on the documentation here: https://github.com/probot/settings#inheritance

Inheritance

This app uses probot-config. This means you can inherit settings from another repo, and only override what you want to change.

And the documentation here: https://github.com/probot/probot-config#an-opt-out-pattern

An opt-out pattern

Alternatively, you may want to default to the config in your .github project and occasionally opt-out. Example:

  # octocat/.github:.github/test.yaml
  shared1: Will be inherited by repo1 and not repo2

  # octocat/repo1:.github/test.yaml <-- missing!
  # Uses octocat/.github:test.yaml instead

  # octocat/repo3:.github/test.yaml <-- either empty or populated
  # Will not inherit shared1, since no _extends field is specified

I expected to be able to create a single <org>/.github repo and have the settings applied to all repositories.

How would we go about getting inheritance to work?

GitHub

probot/settings

Pull Requests for GitHub repository settings. Contribute to probot/settings development by creating an account on GitHub.

GitHub

probot/probot-config

A Probot extension to easily share configs between repositories. - probot/probot-config

[electriquo]

@tchupp: did you try to contribute the documentation by opening a pull-request with your suggestion?

[tchupp]

My comment was more of a question than a suggestion 😬 I'm curious what the expected behavior is, and how we might go about getting opt-out inheritance to work with an organization. I'm happy to make a PR to update docs once I have some direction 😁

[ChipWolf]

Has anyone figured this out yet?

[LayZeeDK]

Duplicate of #95