|
| 1 | +# OCA repo maintainer configuration |
| 2 | + |
| 3 | +This repo contains configuration files to automatically setup teams and repositories in the OCA organization. |
| 4 | + |
| 5 | +## How it works |
| 6 | +When a config change is merged, a Github action will use the [repo-maintainer tool](https://github.com/OCA/repo-maintaine) |
| 7 | +to update or create teams and repositories. |
| 8 | + |
| 9 | +## Conf structure |
| 10 | + |
| 11 | +In the `conf` folder you'll find a `psc` folder and a `repo` folder. |
| 12 | +Each of them contains YAML files. Each file contains the configuration for one or more team/repo. |
| 13 | +The tool does not care about the name of the file or if the file contains 1 or 100 items. |
| 14 | +What matters is that we keep them organized by "category" or "app" as it is now. |
| 15 | + |
| 16 | +NOTE: current files where generated mostly automatically. |
| 17 | +If you think that any of them has not the right name or a piece of content is misplaced, |
| 18 | +feel free to propose a PR to fix it. |
| 19 | + |
| 20 | +## How to add a new repo |
| 21 | + |
| 22 | +1. look for the right category file in the `repo` folder |
| 23 | +2. if not present, create one |
| 24 | +3. add the conf for the new repo, like: |
| 25 | +``` |
| 26 | +account-analytic: # repo slug |
| 27 | + branches: # branches to setup |
| 28 | + - "14.0" |
| 29 | + - "15.0" |
| 30 | + - "16.0" |
| 31 | + category: Account # used for documentation |
| 32 | + default_branch: "14.0" # setup default branch |
| 33 | + name: Odoo account analytic related addons # user friendly name |
| 34 | + psc: accounting-maintainers # maintainers PSC/team |
| 35 | + psc_rep: core-maintainers-psc-representative # maintaners representative team |
| 36 | +``` |
| 37 | +4. commit, push and open a PR against this repo |
| 38 | + |
| 39 | +## How to update a repo |
| 40 | + |
| 41 | +Simply modify any of the parameters above, commit, push and open a PR. |
| 42 | + |
| 43 | +## How to add a new PSC |
| 44 | + |
| 45 | +1. look for the right category file in the `psc` folder |
| 46 | +2. if not present, create one |
| 47 | +3. add the conf for the new psc, like: |
| 48 | +``` |
| 49 | +accounting-maintainers: |
| 50 | + members: |
| 51 | + - user1 |
| 52 | + - user2 |
| 53 | + - userN |
| 54 | + name: Accounting maintainers |
| 55 | + representatives: |
| 56 | + - user4 |
| 57 | + - user5 |
| 58 | +accounting-maintainers-psc-representative: |
| 59 | + members: |
| 60 | + - user6 |
| 61 | + name: Accounting maintainers psc representative |
| 62 | + representatives: [] |
| 63 | +``` |
| 64 | + |
| 65 | +## How to update a PSC |
| 66 | + |
| 67 | +Simply modify any of the parameters above, commit, push and open a PR. |
0 commit comments