Review options and mark some as deprecated due to orgs and users introduction at API level #29
Description
Options
Client parameters for hosted GIT API
| Name | Description | Example |
|---|---|---|
gitlab-url |
URL of git hosting service | http://gitlab.localhost |
gitlab-token |
Auth token for git hosting API |
This parameters should be renamed to url and token (it has no effect for users as it they are not options but command line arguments.
Filter projects
| Name | Description | Example |
|---|---|---|
--orgs |
Filter projects according to orgs/groups | symfony,FriendsOfSymfony |
--users |
Filter projects according to users | mborne,ochorocho |
--include-if-has-file |
Filter projects that doesn't contains a given file | .satisinclude |
--project-type |
Filter projects according to type defined in composer.json |
library |
--ignore |
Filter projects according to a regexp | (^phpstorm) |
--projectFilter |
DEPRECATED Filter projects using search parameter in GITLAB API |
|
--gitlab-namespace |
DEPRECATED Filter projects according to gitlab-namespace | 2,Diaspora |
SATIS generation
| Name | Description | Example |
|---|---|---|
--template |
Use a custom SATIS template instead of default one | satis-template.json |
--name |
Define SATIS repository name | mborne/satis-gitlab-repository |
--homepage |
Define SATIS URL appearing in HTML web page | http://satis.localhost |
--archive |
Download tar ball for dependencies (mirror mode) | |
--no-token |
Disable gitlab-token saving in generated satis.json |
|
--output |
Remplace default output path for satis.json |
Deprecated options
--projectFilter
This option has been introduced to have the hability to filter gitlab.com projects
while listing projects at API level.
--orgs and --users will provide a better control for this use case. --ignore, --include-if-has-file and co will provide a stronger control to complete the job.
--gitlab-namespace
The current implementation is not based on the API of the git hosting service.
--orgs option is more efficient as it provides gitlab group filtering at API level and makes it faster to filter by group on gitlab.com for example.