public_git
/
oauth2-proxy
mirror of https://github.com/oauth2-proxy/oauth2-proxy.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Added documentation (#42) 

## Description

Added documentation with the branch settings, informing the active
policies for the `edi-foundation-integration` and `main` branches.

## How Has This Been Tested?

N/A
This commit is contained in:
Danilo Mendes Rocha 2023-07-04 14:14:43 -03:00 committed by GitHub
parent bd4c47cba9 cca3be094b
commit 77855df05e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 53 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

53
docs/docs/repository-settings.md Normal file
View File

@ -0,0 +1,53 @@
# Repository settings
All these settings are applied to this repository.
| Setting | Value | Info |
|-|-|-|
| Allow merge commits | `enabled` | Default to pull request title and description |
| Allow squash merging | `disabled` | |
| Allow rebase merging | `disabled` | |
| Always suggest updating pull request branches | `enabled` | |
| Allow auto-merge | `enabled` | |
| Automatically delete head branches | `enabled` | |
| Projects | `disabled` | |
| Issues | `disabled` | |
| Allow forking | `enabled` | |
## Add collaborators
Default GitHub teams will be added as collaborator in the repositories granting access to all project members to contribute to the onboarded repositories.
| Team | Role |
|-|-|
| [oauth-proxy-contributors](https://github.com/orgs/philips-forks/teams/oauth-proxy-contributors) | Maintain |
## Create protection rules
These are the protection rules for the `master` and `edi-foundation-integration` branches in order to secury and standarize the way of working.
| Rules | master | edi-foundation-integration | Info |
|-|-|-|-|
| Require a pull request before merging | `Enabled` | `Enabled` | N/A |
| Require approvals | `1` | `1` | N/A |
| Dismiss stale pull request approvals when new commits are pushed | `Enabled` | `Enabled` | N/A |
| Require review from Code Owners | `Enabled` | `Enabled`| N/A |
|Restrict who can dismiss pull request reviews | `Disabled` | `Disabled` | N/A |
| Allow specified actors to bypass required pull requests | `Disabled` | `Disabled` | N/A |
| Require approval of the most recent reviewable push | `Enabled` | `Disabled`| N/A |
| Require status checks to pass before merging | `Enabled` | `Enabled`| N/A |
| Require branches to be up to date before merging | `Disabled` | `Enabled`| N/A |
| Require conversation resolution before merging | `Enabled` | `Enabled`| N/A |
| Require signed commits | `Enabled` | `Enabled`| N/A |
| Require linear history | `Disabled` | `Disabled` | N/A |
| Require merge queue | `Disabled` | `Disabled` | N/A |
| Require deployments to succeed before merging | `Disabled` | `Disabled` | N/A |
| Lock branch | `Enabled` | `Disabled` | N/A |
| Do not allow bypassing the above settings | `Enabled` | `Enabled`| Enforce rules for admin users. |
| Restrict who can push to matching branches | `Disabled` | `Disabled` | N/A |
| Allow force pushes | `Disabled` | `Disabled` | N/A |
| Allow deletions | `Disabled` | `Disabled` | N/A |
## Signed commits
It was added protection for all branches (pattern: `*`, `*/*` and `edi-foundation-integration`) in order to enforce signed commits. This configuration will help avoiding pull request completion issues because it'll enforce everyone to sign the commits in every branch not only in the main branch.