Commit e812b41d authored by Pierre Smeyers's avatar Pierre Smeyers
Browse files

docs: add explanations about NEW_GROUP_OPTIONS / NEW_PROJECT_OPTIONS

parent 459e640b

README.md

+10 −5
Original line number Diff line number Diff line
@@ -84,15 +84,16 @@ options: 
| `--update-avatar`            | `$UPDATE_AVATAR`                | force update the avatar images even when they exist and look the same                                                 |

| `--no-group-description`     | `$GROUP_DESCRIPTION_DISABLED`   | don't synchronize group description                                                                                   |

| `--no-project-description`   | `$PROJECT_DESCRIPTION_DISABLED` | don't synchronize project description                                                                                 |

| `--new-group-options`        | `$NEW_GROUP_OPTIONS`            | a JSON string with extra options for groups creation (no default value)                                               |

| `--new-group-options-from`   | `$NEW_GROUP_OPTIONS_FROM`       | a JSON file with extra options for groups creation; incompatible with --new-group-options                             |

| `--new-project-options`      | `$NEW_PROJECT_OPTIONS`          | a JSON string with extra options for projects creation (default value disables issues and MR, *see below*)            |

| `--new-project-options-from` | `$NEW_PROJECT_OPTIONS_FROM`     | a JSON file with extra options for projects creation; incompatible with --new-project-options                         |

| `--new-group-options`        | `$NEW_GROUP_OPTIONS`            | a JSON string with [extra options for groups creation](https://docs.gitlab.com/api/groups/#create-a-group) (no default value)                                               |

| `--new-group-options-from`   | `$NEW_GROUP_OPTIONS_FROM`       | a JSON file with [extra options for groups creation](https://docs.gitlab.com/api/groups/#create-a-group); incompatible with `--new-group-options`                             |

| `--new-project-options`      | `$NEW_PROJECT_OPTIONS`          | a JSON string with [extra options for projects creation](https://docs.gitlab.com/api/projects/#create-a-project) (default value disables issues and MR, *see below*)            |

| `--new-project-options-from` | `$NEW_PROJECT_OPTIONS_FROM`     | a JSON file with [extra options for projects creation](https://docs.gitlab.com/api/projects/#create-a-project); incompatible with `--new-project-options`                         |

| `--dry-run`                  | `$DRY_RUN`                      | dry run (don't execute any write action)                                                                              |

| `--halt-on-error`            | `$HALT_ON_ERROR`                | halt synchronizing when an error occurs                                                                               |

| `--cache-dir`                | `$CACHE_DIR`                    | cache directory (used to download resources such as images and Git repositories) (defaults to `.work`)                |



Default options for creating new projects:

Projects are copied with the following default options:



```json

{

  "issues_access_level": "disabled",
@@ -100,6 +101,10 @@ Default options for creating new projects: 
}

```



You can customize those default options with your own ones with the `--new-project-options` / `--new-project-options-from` CLI options.



Similarly, you can customize default group options with the `--new-group-options` / `--new-group-options-from` CLI options.



## Developers



`gitlab-cp` is implemented in Python and relies on [Poetry](https://python-poetry.org/) for its packaging and dependency management.