gerrit¶
[1m [0m
[1m [0m[1;33mUsage: [0m[1mlftools-uv gerrit [OPTIONS] COMMAND [ARGS]...[0m[1m [0m[1m [0m
[1m [0m
GERRIT TOOLS.
[2mâ•â”€[0m[2m Options [0m[2m───────────────────────────────────────────────────────────────────[0m[2m─╮[0m
[2m│[0m [1;36m-[0m[1;36m-help[0m Show this message and exit. [2m│[0m
[2m╰──────────────────────────────────────────────────────────────────────────────╯[0m
[2mâ•â”€[0m[2m Commands [0m[2m──────────────────────────────────────────────────────────────────[0m[2m─╮[0m
[2m│[0m [1;36maddfile [0m[1;36m [0m Add a file for review to a Project. [2m│[0m
[2m│[0m [1;36maddinfojob [0m[1;36m [0m Add an INFO job for a new Project. [2m│[0m
[2m│[0m [1;36maddgitreview [0m[1;36m [0m Add git review to a project. [2m│[0m
[2m│[0m [1;36maddgithubrights [0m[1;36m [0m Grant Github read for a project. [2m│[0m
[2m│[0m [1;36mabandonchanges [0m[1;36m [0m Abandon all OPEN changes for a gerrit project. [2m│[0m
[2m│[0m [1;36mcreateproject [0m[1;36m [0m Create a project via the gerrit API. [2m│[0m
[2m│[0m [1;36mcreate-saml-group [0m[1;36m [0m Create saml group based on ldap group. [2m│[0m
[2m│[0m [1;36mlist-project-permissions [0m[1;36m [0m List Owners of a Project. [2m│[0m
[2m│[0m [1;36mlist-project-inherits-from [0m[1;36m [0m List who a project inherits from. [2m│[0m
[2m│[0m [1;36maddmavenconfig [0m[1;36m [0m Add maven config file for JCasC. [2m│[0m
[2m╰──────────────────────────────────────────────────────────────────────────────╯[0m
Commands¶
list-project-permissions¶
[1m [0m
[1m [0m[1;33mUsage: [0m[1mlftools-uv gerrit list-project-permissions [OPTIONS] GERRIT_FQDN[0m[1m [0m[1m [0m
[1m [0m[1m PROJECT[0m[1m [0m[1m [0m
[1m [0m
List Owners of a Project.
[2mâ•â”€[0m[2m Arguments [0m[2m─────────────────────────────────────────────────────────────────[0m[2m─╮[0m
[2m│[0m [31m*[0m gerrit_fqdn [1;33mTEXT[0m Gerrit FQDN [2m│[0m
[2m│[0m [2;31m[required] [0m [2m│[0m
[2m│[0m [31m*[0m project [1;33mTEXT[0m Project name [2m│[0m
[2m│[0m [2;31m[required] [0m [2m│[0m
[2m╰──────────────────────────────────────────────────────────────────────────────╯[0m
[2mâ•â”€[0m[2m Options [0m[2m───────────────────────────────────────────────────────────────────[0m[2m─╮[0m
[2m│[0m [1;36m-[0m[1;36m-help[0m Show this message and exit. [2m│[0m
[2m╰──────────────────────────────────────────────────────────────────────────────╯[0m
list-project-inherits-from¶
[1m [0m
[1m [0m[1;33mUsage: [0m[1mlftools-uv gerrit list-project-inherits-from [OPTIONS] GERRIT_FQDN[0m[1m [0m[1m [0m
[1m [0m[1m GERRIT_PROJECT[0m[1m [0m[1m [0m
[1m [0m
List who a project inherits from.
[2mâ•â”€[0m[2m Arguments [0m[2m─────────────────────────────────────────────────────────────────[0m[2m─╮[0m
[2m│[0m [31m*[0m gerrit_fqdn [1;33mTEXT[0m Gerrit FQDN [2m│[0m
[2m│[0m [2;31m[required] [0m [2m│[0m
[2m│[0m [31m*[0m gerrit_project [1;33mTEXT[0m Gerrit project name [2m│[0m
[2m│[0m [2;31m[required] [0m [2m│[0m
[2m╰──────────────────────────────────────────────────────────────────────────────╯[0m
[2mâ•â”€[0m[2m Options [0m[2m───────────────────────────────────────────────────────────────────[0m[2m─╮[0m
[2m│[0m [1;36m-[0m[1;36m-help[0m Show this message and exit. [2m│[0m
[2m╰──────────────────────────────────────────────────────────────────────────────╯[0m
abandonchanges¶
[1m [0m
[1m [0m[1;33mUsage: [0m[1mlftools-uv gerrit abandonchanges [OPTIONS] GERRIT_FQDN GERRIT_PROJECT[0m[1m [0m[1m [0m
[1m [0m
Abandon all OPEN changes for a gerrit project.
[2mgerrit_url gerrit.o-ran-sc.org[0m[2m [0m[2mgerrit_project test/test1[0m
[2mâ•â”€[0m[2m Arguments [0m[2m─────────────────────────────────────────────────────────────────[0m[2m─╮[0m
[2m│[0m [31m*[0m gerrit_fqdn [1;33mTEXT[0m Gerrit FQDN [2m│[0m
[2m│[0m [2;31m[required] [0m [2m│[0m
[2m│[0m [31m*[0m gerrit_project [1;33mTEXT[0m Gerrit project name [2m│[0m
[2m│[0m [2;31m[required] [0m [2m│[0m
[2m╰──────────────────────────────────────────────────────────────────────────────╯[0m
[2mâ•â”€[0m[2m Options [0m[2m───────────────────────────────────────────────────────────────────[0m[2m─╮[0m
[2m│[0m [1;36m-[0m[1;36m-help[0m Show this message and exit. [2m│[0m
[2m╰──────────────────────────────────────────────────────────────────────────────╯[0m
addgitreview¶
[1m [0m
[1m [0m[1;33mUsage: [0m[1mlftools-uv gerrit addgitreview [OPTIONS] GERRIT_FQDN GERRIT_PROJECT[0m[1m [0m[1m [0m
[1m [0m
Add git review to a project.
[2mExample:[0m[2m [0m[2mgerrit_url gerrit.o-ran-sc.org[0m[2m [0m[2mgerrit_project test/test1[0m
[2mâ•â”€[0m[2m Arguments [0m[2m─────────────────────────────────────────────────────────────────[0m[2m─╮[0m
[2m│[0m [31m*[0m gerrit_fqdn [1;33mTEXT[0m Gerrit FQDN [2m│[0m
[2m│[0m [2;31m[required] [0m [2m│[0m
[2m│[0m [31m*[0m gerrit_project [1;33mTEXT[0m Gerrit project name [2m│[0m
[2m│[0m [2;31m[required] [0m [2m│[0m
[2m╰──────────────────────────────────────────────────────────────────────────────╯[0m
[2mâ•â”€[0m[2m Options [0m[2m───────────────────────────────────────────────────────────────────[0m[2m─╮[0m
[2m│[0m [1;36m-[0m[1;36m-issue[0m[1;36m-id[0m [1;33mTEXT[0m For projects that enforce an issue id for changesets [2m│[0m
[2m│[0m [1;36m-[0m[1;36m-help[0m [1;33m [0m Show this message and exit. [2m│[0m
[2m╰──────────────────────────────────────────────────────────────────────────────╯[0m
addgithubrights¶
[1m [0m
[1m [0m[1;33mUsage: [0m[1mlftools-uv gerrit addgithubrights [OPTIONS] GERRIT_FQDN GERRIT_PROJECT[0m[1m [0m[1m [0m
[1m [0m
Grant Github read for a project.
[2mgerrit_url gerrit.o-ran-sc.org[0m[2m [0m[2mgerrit_project test/test1[0m
[2mâ•â”€[0m[2m Arguments [0m[2m─────────────────────────────────────────────────────────────────[0m[2m─╮[0m
[2m│[0m [31m*[0m gerrit_fqdn [1;33mTEXT[0m Gerrit FQDN [2m│[0m
[2m│[0m [2;31m[required] [0m [2m│[0m
[2m│[0m [31m*[0m gerrit_project [1;33mTEXT[0m Gerrit project name [2m│[0m
[2m│[0m [2;31m[required] [0m [2m│[0m
[2m╰──────────────────────────────────────────────────────────────────────────────╯[0m
[2mâ•â”€[0m[2m Options [0m[2m───────────────────────────────────────────────────────────────────[0m[2m─╮[0m
[2m│[0m [1;36m-[0m[1;36m-help[0m Show this message and exit. [2m│[0m
[2m╰──────────────────────────────────────────────────────────────────────────────╯[0m
addfile¶
[1m [0m
[1m [0m[1;33mUsage: [0m[1mlftools-uv gerrit addfile [OPTIONS] GERRIT_FQDN GERRIT_PROJECT FILENAME[0m[1m [0m
[1m [0m
Add a file for review to a Project.
[2mRequires gerrit directory.[0m
[2mExample:[0m
[2mgerrit_url gerrit.o-ran-sc.org/r[0m[2m [0m[2mgerrit_project test/test1[0m
[2mâ•â”€[0m[2m Arguments [0m[2m─────────────────────────────────────────────────────────────────[0m[2m─╮[0m
[2m│[0m [31m*[0m gerrit_fqdn [1;33mTEXT[0m Gerrit FQDN [2m│[0m
[2m│[0m [2;31m[required] [0m [2m│[0m
[2m│[0m [31m*[0m gerrit_project [1;33mTEXT[0m Gerrit project name [2m│[0m
[2m│[0m [2;31m[required] [0m [2m│[0m
[2m│[0m [31m*[0m filename [1;33mTEXT[0m Filename to add [2m│[0m
[2m│[0m [2;31m[required] [0m [2m│[0m
[2m╰──────────────────────────────────────────────────────────────────────────────╯[0m
[2mâ•â”€[0m[2m Options [0m[2m───────────────────────────────────────────────────────────────────[0m[2m─╮[0m
[2m│[0m [1;36m-[0m[1;36m-issue[0m[1;36m-id[0m [1;33mTEXT[0m For projects that enforce an issue id for [2m│[0m
[2m│[0m changesets [2m│[0m
[2m│[0m [1;36m-[0m[1;36m-file[0m[1;36m-location[0m [1;33mTEXT[0m File path within the repository [2m│[0m
[2m│[0m [1;36m-[0m[1;36m-help[0m [1;33m [0m Show this message and exit. [2m│[0m
[2m╰──────────────────────────────────────────────────────────────────────────────╯[0m
createproject¶
[1m [0m
[1m [0m[1;33mUsage: [0m[1mlftools-uv gerrit createproject [OPTIONS] GERRIT_FQDN GERRIT_PROJECT[0m[1m [0m[1m [0m
[1m [0m[1m LDAP_GROUP[0m[1m [0m[1m [0m
[1m [0m
Create a project via the gerrit API.
[2mCreates a gerrit project.[0m[2m [0m[2mSets ldap group as owner.[0m
[2mExample:[0m
[2mgerrit_url gerrit.o-ran-sc.org/r[0m[2m [0m[2mgerrit_project test/test1[0m[2m [0m[2mldap_group [0m
[2moran-gerrit-test-test1-committers[0m
[2mâ•â”€[0m[2m Arguments [0m[2m─────────────────────────────────────────────────────────────────[0m[2m─╮[0m
[2m│[0m [31m*[0m gerrit_fqdn [1;33mTEXT[0m Gerrit FQDN [2m│[0m
[2m│[0m [2;31m[required] [0m [2m│[0m
[2m│[0m [31m*[0m gerrit_project [1;33mTEXT[0m Gerrit project name [2m│[0m
[2m│[0m [2;31m[required] [0m [2m│[0m
[2m│[0m [31m*[0m ldap_group [1;33mTEXT[0m LDAP group name [2m│[0m
[2m│[0m [2;31m[required] [0m [2m│[0m
[2m╰──────────────────────────────────────────────────────────────────────────────╯[0m
[2mâ•â”€[0m[2m Options [0m[2m───────────────────────────────────────────────────────────────────[0m[2m─╮[0m
[2m│[0m [31m*[0m [1;36m-[0m[1;36m-description[0m [1;33mTEXT[0m Project Description [2m│[0m
[2m│[0m [2;31m[required] [0m [2m│[0m
[2m│[0m [1;36m-[0m[1;36m-check[0m [1;33m [0m just check if the project exists [2m│[0m
[2m│[0m [1;36m-[0m[1;36m-help[0m [1;33m [0m Show this message and exit. [2m│[0m
[2m╰──────────────────────────────────────────────────────────────────────────────╯[0m
create-saml-group¶
[1m [0m
[1m [0m[1;33mUsage: [0m[1mlftools-uv gerrit create-saml-group [OPTIONS] GERRIT_FQDN LDAP_GROUP[0m[1m [0m[1m [0m
[1m [0m
Create saml group based on ldap group.
[2mâ•â”€[0m[2m Arguments [0m[2m─────────────────────────────────────────────────────────────────[0m[2m─╮[0m
[2m│[0m [31m*[0m gerrit_fqdn [1;33mTEXT[0m Gerrit FQDN [2m│[0m
[2m│[0m [2;31m[required] [0m [2m│[0m
[2m│[0m [31m*[0m ldap_group [1;33mTEXT[0m LDAP group name [2m│[0m
[2m│[0m [2;31m[required] [0m [2m│[0m
[2m╰──────────────────────────────────────────────────────────────────────────────╯[0m
[2mâ•â”€[0m[2m Options [0m[2m───────────────────────────────────────────────────────────────────[0m[2m─╮[0m
[2m│[0m [1;36m-[0m[1;36m-help[0m Show this message and exit. [2m│[0m
[2m╰──────────────────────────────────────────────────────────────────────────────╯[0m
addinfojob¶
[1m [0m
[1m [0m[1;33mUsage: [0m[1mlftools-uv gerrit addinfojob [OPTIONS] GERRIT_FQDN GERRIT_PROJECT[0m[1m [0m[1m [0m
[1m [0m[1m JJBREPO[0m[1m [0m[1m [0m
[1m [0m
Add an INFO job for a new Project.
[2mAdds info verify jenkins job for project.[0m[2m [0m[2mresult['id'] can be used to amend a [0m
[2mreview[0m[2m [0m[2mso that multiple projects can have info jobs added[0m[2m [0m[2min a single review[0m
[2mExample:[0m
[2mgerrit_url gerrit.o-ran-sc.org/r[0m[2m [0m[2mgerrit_project test/test1[0m[2m [0m[2mjjbrepo [0m
[2mci-mangement[0m
[2mâ•â”€[0m[2m Arguments [0m[2m─────────────────────────────────────────────────────────────────[0m[2m─╮[0m
[2m│[0m [31m*[0m gerrit_fqdn [1;33mTEXT[0m Gerrit FQDN [2m│[0m
[2m│[0m [2;31m[required] [0m [2m│[0m
[2m│[0m [31m*[0m gerrit_project [1;33mTEXT[0m Gerrit project name [2m│[0m
[2m│[0m [2;31m[required] [0m [2m│[0m
[2m│[0m [31m*[0m jjbrepo [1;33mTEXT[0m JJB repository name [2m│[0m
[2m│[0m [2;31m[required] [0m [2m│[0m
[2m╰──────────────────────────────────────────────────────────────────────────────╯[0m
[2mâ•â”€[0m[2m Options [0m[2m───────────────────────────────────────────────────────────────────[0m[2m─╮[0m
[2m│[0m [1;36m-[0m[1;36m-issue[0m[1;36m-id[0m [1;33mTEXT[0m For projects that enforce an issue id for changesets [2m│[0m
[2m│[0m [1;36m-[0m[1;36m-agent[0m [1;33mTEXT[0m Specify the Jenkins agent label to run the job on [2m│[0m
[2m│[0m [1;36m-[0m[1;36m-help[0m [1;33m [0m Show this message and exit. [2m│[0m
[2m╰──────────────────────────────────────────────────────────────────────────────╯[0m
Note
Gerrit API methods require configuration in lftools-uv.ini in a global [gerrit] section. support for [gerrit.umbrella.tld] exists as well signed_off_by required to push changes. Projects that do not allow self merge will require as project.example.org.second section for submission of their .gitreview on project creation.
[gerrit.example.org]
username = lfid
password = password
signed_off_by = Your Name <your@email.org>
[gerrit.example.org.second]
username = lfid2
password = password2
signed_off_by = Your Name <your@email.org>
addmavenconfig¶
[1m [0m
[1m [0m[1;33mUsage: [0m[1mlftools-uv gerrit addmavenconfig [OPTIONS] GERRIT_FQDN GERRIT_PROJECT[0m[1m [0m[1m [0m
[1m [0m[1m JJBREPO[0m[1m [0m[1m [0m
[1m [0m
Add maven config file for JCasC.
[2mThe following options can be set in the gerrit server's entry in lftools.ini:[0m
[1;33m • [0m[2mdefault_servers: Comma-separated list of servers using the [0m[2m [0m[2mcredential. [0m[2m [0m
[1;33m [0m[2mDefault: releases,snapshots,staging,site[0m[2m [0m
[1;33m • [0m[2madditional_credentials: JSON-formatted string containing[0m[2m [0m[2m [0m
[1;33m [0m[2mservername:credentialname pairings. This should be on a single line,[0m[2m [0m[2m [0m
[1;33m [0m[2mwithout quotes surrounding the string.[0m[2m [0m
[1;33m • [0m[2mnexus3: The nexus3 server url for a given project.[0m[2m [0m
[1;33m • [0m[2mnexus3_ports: Comma-separated list of ports used by Nexus3.[0m[2m [0m[2mDefault: [0m[2m [0m
[1;33m [0m[2m10001,10002,10003,10004[0m[2m [0m
[2mâ•â”€[0m[2m Arguments [0m[2m─────────────────────────────────────────────────────────────────[0m[2m─╮[0m
[2m│[0m [31m*[0m gerrit_fqdn [1;33mTEXT[0m Gerrit FQDN [2m│[0m
[2m│[0m [2;31m[required] [0m [2m│[0m
[2m│[0m [31m*[0m gerrit_project [1;33mTEXT[0m Gerrit project name [2m│[0m
[2m│[0m [2;31m[required] [0m [2m│[0m
[2m│[0m [31m*[0m jjbrepo [1;33mTEXT[0m JJB repository name [2m│[0m
[2m│[0m [2;31m[required] [0m [2m│[0m
[2m╰──────────────────────────────────────────────────────────────────────────────╯[0m
[2mâ•â”€[0m[2m Options [0m[2m───────────────────────────────────────────────────────────────────[0m[2m─╮[0m
[2m│[0m [1;36m-[0m[1;36m-issue[0m[1;36m-id[0m [1;33mTEXT[0m For projects that enforce an issue id for [2m│[0m
[2m│[0m changesets [2m│[0m
[2m│[0m [1;36m-[0m[1;36m-nexus3[0m [1;33mTEXT[0m Specify a Nexus 3 server, e.g. [2m│[0m
[2m│[0m nexus3.example.org [2m│[0m
[2m│[0m [1;36m-[0m[1;36m-nexus3[0m[1;36m-ports[0m [1;33mTEXT[0m Comma-separated list of ports supported by the [2m│[0m
[2m│[0m Nexus 3 server specified [2m│[0m
[2m│[0m [1;36m-[0m[1;36m-help[0m [1;33m [0m Show this message and exit. [2m│[0m
[2m╰──────────────────────────────────────────────────────────────────────────────╯[0m
An example of the lftools-uv.ini entry for a Gerrit server making use of a full configuration:
[gerrit.example.org]
username = lfid
password = password
signed_off_by = Your Name <your@email.org>
endpoint = https://gerrit.example.org/
default_servers = releases,snapshots,staging,site
nexus3 = nexus3.example.org
nexus3_ports = 10001,10002,10003,10004
additional_credentials = {"docker.io": "dockerhub-cred", "nexus-iq": "nexus-iq-cred"}