Skip to content
This repository has been archived by the owner on Feb 13, 2023. It is now read-only.

Correct default org repo documentation #360

Merged
merged 2 commits into from
Feb 16, 2022
Merged

Correct default org repo documentation #360

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0137983
Correct default org repo documentation
JoshuaTheMiller Jan 25, 2022
f274cd1
Add clarification around .github folder
JoshuaTheMiller Jan 26, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions .github/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,8 +161,10 @@ Once you have the **GitHub App** up and running, users will need to add the conf
- Having this file in the root of the repository is what signals the **Rally + GitHub App** to view all configured events for the repository
- The configuration file allows users to make small customizations to how the bot interacts with their codebase
- Users will also want to configure `protected branches` to help make sure all rules are followed and enforced by the validator bot
- If a default configuration for all repositories in an organization is desirable, create a `.github/rally.yml` file in a repository called `[ORG_NAME]/rally-github-config`. The name of this configuration repository can also be set as an environment variable.
- If a _per_-repository configuration needs to be managed from a central repository, create a `.github/rally/[REPO_NAME].yml` file in a repository called `[ORG_NAME]/rally-github-config` instead.
- If a default configuration for all repositories in an organization is desirable, create a `.github/rally.yml` file in a repository called `[ORG_NAME]/.github`.
- The name of this configuration repository can also be set as an environment variable (i.e., this bot can look in a repository other than `[ORG_NAME]/.github`).
- Additionally, if a _per_-repository configuration needs to be managed from this central configuration repository, create such configuration files under a folder named `.github/rally` (e.g., `.github/rally/[REPO_NAME].yml`).
- Please note that the `rally.yml` file must still be placed in a `.github` folder, even if the repository itself is named `.github` (at least at the time of [this update](https://github.com/github/rally/blob/68e3294f044999748fdf61cb163ac60531a03ee8/lib/RallyValidate.js#L109)).

## How to contribute
We invite you to contribute to this **GitHub App**! Check out [Issues](https://github.com/github/rally/issues) (especially those labeled `help wanted` or `good first issue`) and jump over to [CONTRIBUTING](https://github.com/github/rally/blob/main/.github/CONTRIBUTING.md) for more details.
Expand Down