uffizzi-cli 0.11.4 → 0.14.0

data/man/uffizzi-connect-gcr.ronn

@@ -1,32 +1,36 @@
-uffizzi-connect-gcr - grant a Uffizzi user account access to a private Google Container Registry (GCR)
-================================================================
+# uffizzi-connect-gcr - grant a Uffizzi user account access to a private Google Container Registry (GCR)
 
 ## SYNOPSIS
-    uffizzi connect gcr [KEY_FILE]
+
+`uffizzi connect gcr` [KEY_FILE]
 
 ## DESCRIPTION
-    Given valid credentials, grants a Uffizzi user account access 
-    to a private Google Container Registry
 
-    This command can fail for the following reasons:
-        - The active user does not have permission to connect 
-          external services.
-        - The given credentials are invalid.
+Given valid credentials, grants a Uffizzi user account access 
+to a private Google Container Registry
+
+Credentials can be provided via a key file or environment variable:  
+`GCLOUD_SERVICE_KEY`
+
+This command can fail for the following reasons:
+- The active user does not have permission to connect external services.
+- The given credentials are invalid.
 
-    For more information on connecting to external services, see:
-    https://github.com/UffizziCloud/uffizzi_cli
+For more information on connecting to external services, see:  
+https://github.com/UffizziCloud/uffizzi_cli
 
-    For detailed instructions on configuring webhooks to send push
-    notifications to Uffizzi, see 
-    https://docs.uffizzi.com/guides/container-registry-integrations
+For detailed instructions on configuring webhooks to send push
+notifications to Uffizzi, see:  
+https://docs.uffizzi.com/guides/container-registry-integrations
 
-## POSITIONAL ARGUMENTS
-    KEY_FILE
-        A Google Cloud service account key file. The key file is a 
-        JSON file that grants Uffizzi access to a private GCR.
+## ARGUMENTS
+
+* KEY_FILE:
+  A Google Cloud service account key file. The key file is a JSON file that grants Uffizzi access to a private GCR.
 
 ## EXAMPLES
-    The following command uses a Google Cloud service account key 
-    file called sa-private-key.json to connect to a private GCR:
-          
-        $ uffizzi connect gcr sa-private-key.json
+
+The following command uses a Google Cloud service account key 
+file called sa-private-key.json to connect to a private GCR:
+
+`uffizzi connect gcr sa-private-key.json`

data/man/uffizzi-connect-ghcr

@@ -1,44 +1,34 @@
 .\" generated with Ronn-NG/v0.9.1
 .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
-.TH "UFFIZZI\-CONNECT\-GHCR" "" "July 2022" ""
+.TH "UFFIZZI\-CONNECT\-GHCR" "" "August 2022" ""
 .SH "NAME"
 \fBuffizzi\-connect\-ghcr\fR \- grant a Uffizzi user account access to a private GitHub Container Registry (GHCR)
 .SH "SYNOPSIS"
-.nf
-uffizzi connect ghcr [OPTION]\|\.\|\.\|\.
-.fi
+\fBuffizzi connect ghcr\fR [\-\-username=USERNAME] [\-\-token=TOKEN]
 .SH "DESCRIPTION"
-.nf
-Given valid credentials, grants a Uffizzi user account access
-to a private GitHub Container Registry\.
-
-Credentials can be provided interactively or non\-interactively
-via command options or environment variables:
-GITHUB_USERNAME, GITHUB_ACCESS_TOKEN
-
-This command can fail for the following reasons:
-    \- The active user does not have permission to connect
-      external services\.
-    \- The given credentials are invalid\.
-
+Given valid credentials, grants a Uffizzi user account access to a private GitHub Container Registry\.
+.P
+Credentials can be provided interactively or non\-interactively via command options or environment variables:
+.br
+\fBGITHUB_USERNAME\fR, \fBGITHUB_ACCESS_TOKEN\fR
+.P
+This command can fail for the following reasons: \- The active user does not have permission to connect external services\. \- The given credentials are invalid\.
+.P
 For more information on connecting to external services, see:
+.br
 https://github\.com/UffizziCloud/uffizzi_cli
-
-For detailed instructions on configuring webhooks to send push
-notifications to Uffizzi, see
+.P
+For detailed instructions on configuring webhooks to send push notifications to Uffizzi, see:
+.br
 https://docs\.uffizzi\.com/guides/container\-registry\-integrations
-.fi
 .SH "OPTIONS"
-.nf
-\-u, \-\-username        GitHub username
-\-t, \-\-token           Personal access token from GitHub
-.fi
+.TP
+\fB\-u\fR, \fB\-\-username=<username>\fR
+Username for the service\.
+.TP
+\fB\-t\fR, \fB\-\-token=<token>\fR
+Access token for the service\.
 .SH "EXAMPLES"
-.nf
-The following command will prompt the user to enter GHCR
-credentials, including GitHub account name and
-personal access token (PAT):
-
-uffizzi connect ghcr
-.fi
-
+The following command will prompt the user to enter GHCR credentials, including GitHub account name and personal access token (PAT):
+.P
+\fBuffizzi connect ghcr\fR

data/man/uffizzi-connect-ghcr.ronn

@@ -1,36 +1,40 @@
-uffizzi-connect-ghcr - grant a Uffizzi user account access to a private GitHub Container Registry (GHCR)
-================================================================
+# uffizzi-connect-ghcr - grant a Uffizzi user account access to a private GitHub Container Registry (GHCR)
 
 ## SYNOPSIS
-    uffizzi connect ghcr [OPTION]...
+
+`uffizzi connect ghcr` [--username=USERNAME] [--token=TOKEN]
 
 ## DESCRIPTION
-    Given valid credentials, grants a Uffizzi user account access
-    to a private GitHub Container Registry.
 
-    Credentials can be provided interactively or non-interactively
-    via command options or environment variables:
-    GITHUB_USERNAME, GITHUB_ACCESS_TOKEN
+Given valid credentials, grants a Uffizzi user account access
+to a private GitHub Container Registry.
+
+Credentials can be provided interactively or non-interactively
+via command options or environment variables:  
+`GITHUB_USERNAME`, `GITHUB_ACCESS_TOKEN`
 
-    This command can fail for the following reasons:
-        - The active user does not have permission to connect
-          external services.
-        - The given credentials are invalid.
+This command can fail for the following reasons:
+- The active user does not have permission to connect external services.
+- The given credentials are invalid.
 
-    For more information on connecting to external services, see:
-    https://github.com/UffizziCloud/uffizzi_cli
+For more information on connecting to external services, see:  
+https://github.com/UffizziCloud/uffizzi_cli
 
-    For detailed instructions on configuring webhooks to send push
-    notifications to Uffizzi, see
-    https://docs.uffizzi.com/guides/container-registry-integrations
+For detailed instructions on configuring webhooks to send push
+notifications to Uffizzi, see:  
+https://docs.uffizzi.com/guides/container-registry-integrations
 
 ## OPTIONS
-    -u, --username        GitHub username
-    -t, --token           Personal access token from GitHub
+
+* `-u`, `--username=<username>`:
+  Username for the service.
+* `-t`, `--token=<token>`:
+  Access token for the service.
 
 ## EXAMPLES
-    The following command will prompt the user to enter GHCR
-    credentials, including GitHub account name and
-    personal access token (PAT):
 
-    uffizzi connect ghcr
+The following command will prompt the user to enter GHCR
+credentials, including GitHub account name and
+personal access token (PAT):
+
+`uffizzi connect ghcr`

data/man/uffizzi-connect.ronn

@@ -1,31 +1,45 @@
-uffizzi-connect - grant a Uffizzi user account access to external services
-================================================================
+# uffizzi-connect - grant a Uffizzi user account access to external services
 
 ## SYNOPSIS
-    uffizzi connect COMMAND
+
+`uffizzi connect` COMMAND [--skip-raise-existence-error] [--update-credential-if-exists]
 
 ## DESCRIPTION
-    Grants a Uffizzi user account access to external services
 
-    For more information on connecting to external services, see:
-    https://github.com/UffizziCloud/uffizzi_cli
+Grants a Uffizzi user account access to external services.
+
+For more information on connecting to external services, see:  
+https://github.com/UffizziCloud/uffizzi_cli
 
 ## COMMANDS
-    COMMAND is one of the following:
 
-    acr
-        Connect to Azure Container Registry (azurecr.io).
+COMMAND is one of the following:
+
+* `acr`:
+  Connect to Azure Container Registry (azurecr.io).
+
+* `docker-hub`:
+  Connect to Docker Hub (hub.docker.com).
+
+* `docker-registry`:
+  Connect to any registry implementing the Docker Registry HTTP API protocol
+
+* `ecr`:
+  Connect to Amazon Elastic Container Registry (amazonaws.com).
+
+* `gcr`:
+  Connect to Google Container Registry (gcr.io).
+
+* `ghcr`:
+  Connect to GitHub Container Registry (ghcr.io).
 
-    docker-hub
-        Connect to Docker Hub (hub.docker.com).
 
-    ecr
-        Connect to Amazon Elastic Container Registry (amazonaws.com).
+## FLAGS
 
-    gcr
-        Connect to Google Container Registry (gcr.io).
+* `--skip-raise-existence-error`:
+  If credential exists, do not raise an exception, just print a message.
 
-    ghcr
-        Connect to GitHub Container Registry (ghcr.io).
+* `--update-credential-if-exists`:
+  Update credential if it exists.
 
-Run 'uffizzi connect COMMAND --help' for more information on a command.
+Run `uffizzi connect COMMAND --help` for more information on a command.

data/man/uffizzi-preview-create

@@ -1,6 +1,6 @@
 .\" generated with Ronn-NG/v0.9.1
 .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
-.TH "UFFIZZI\-PREVIEW\-CREATE" "" "May 2022" ""
+.TH "UFFIZZI\-PREVIEW\-CREATE" "" "August 2022" ""
 .SH "NAME"
 \fBuffizzi\-preview\-create\fR \- create a preview
 .SH "SYNOPSIS"
@@ -32,6 +32,12 @@ https://github\.com/UffizziCloud/uffizzi_cli
     the previews they create: when the preview is deleted, the
     alternate compose is deleted by the Uffizzi API\.
 .fi
+.SH "FLAGS"
+.nf
+\-\-set\-labels=METADATA
+    Metadata of deployment that contains any information which can
+    be usefull for filtering deployments\.
+.fi
 .SH "UFFIZZI WIDE FLAGS"
 .nf
 These flags are available to all commands: \-\-project\. Run $ uffizzi
@@ -46,5 +52,14 @@ To create a preview with the project\'s default compose file, run:
 To create a preview with an alternate compose file, run:
 
     $ uffizzi preview create docker\-compose\.uffizzi\.alt\.yml
+
+To create a preview with single label, run:
+
+    $ uffizzi preview create \-\-set\-labels github\.repo=my_repo
+
+To create a preview with multiple labels, run:
+
+    $ uffizzi preview create \e
+    \-\-set\-labels="github\.repo=my_repo github\.pull_request\.number=23"
 .fi
 

data/man/uffizzi-preview-create.ronn

@@ -27,6 +27,11 @@ uffizzi-preview-create - create a preview
         the previews they create: when the preview is deleted, the 
         alternate compose is deleted by the Uffizzi API. 
 
+## FLAGS
+    --set-labels=METADATA
+        Metadata of deployment that contains any information which can
+        be usefull for filtering deployments.
+
 ## UFFIZZI WIDE FLAGS
     These flags are available to all commands: --project. Run $ uffizzi 
     help for details.
@@ -39,3 +44,12 @@ uffizzi-preview-create - create a preview
     To create a preview with an alternate compose file, run:
 
         $ uffizzi preview create docker-compose.uffizzi.alt.yml
+
+    To create a preview with single label, run:
+
+        $ uffizzi preview create --set-labels github.repo=my_repo
+
+    To create a preview with multiple labels, run:
+
+        $ uffizzi preview create \
+        --set-labels="github.repo=my_repo github.pull_request.number=23"

data/man/uffizzi-preview-list

@@ -1,6 +1,6 @@
 .\" generated with Ronn-NG/v0.9.1
 .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
-.TH "UFFIZZI\-PREVIEW\-LIST" "" "May 2022" ""
+.TH "UFFIZZI\-PREVIEW\-LIST" "" "August 2022" ""
 .SH "NAME"
 \fBuffizzi\-preview\-list\fR \- list previews in a project
 .SH "SYNOPSIS"
@@ -15,6 +15,15 @@ deploying and failed previews\.
 For more information on Uffizzi previews, see:
 https://github\.com/UffizziCloud/uffizzi_cli
 .fi
+.SH "FLAGS"
+.nf
+\-\-filter=METADATA
+    Metadata to filtering list of deployments\.
+
+\-\-output=json
+    Use this option for a more detailed description of listed
+    deployments\.
+.fi
 .SH "UFFIZZI WIDE FLAGS"
 .nf
 These flags are available to all commands: \-\-project\. Run $ uffizzi
@@ -29,5 +38,20 @@ To list all previews in the default project, run:
 To list all previews in a project with name my_project, run:
 
     $ uffizzi preview list \-\-project="my_project"
+
+To list all previews in json format, run:
+
+    $ uffizzi preview list \-\-output="json"
+
+To list all previews filtered by metadata using single
+label, run:
+
+    $ uffizzi preview list \-\-filter github\.repo=my_repo
+
+To list all previews filtered by metadata using multiple
+labels, run:
+
+    $ uffizzi preview list \e
+    \-\-filter="github\.repo=my_repo github\.pull_request\.number=23"
 .fi
 

data/man/uffizzi-preview-list.ronn

@@ -11,6 +11,14 @@ uffizzi-preview-list - list previews in a project
     For more information on Uffizzi previews, see:
     https://github.com/UffizziCloud/uffizzi_cli
 
+## FLAGS
+    --filter=METADATA
+        Metadata to filtering list of deployments.
+
+    --output=json
+        Use this option for a more detailed description of listed
+        deployments.
+
 ## UFFIZZI WIDE FLAGS
     These flags are available to all commands: --project. Run $ uffizzi 
     help for details.
@@ -23,3 +31,18 @@ uffizzi-preview-list - list previews in a project
     To list all previews in a project with name my_project, run:
 
         $ uffizzi preview list --project="my_project"
+
+    To list all previews in json format, run:
+
+        $ uffizzi preview list --output="json"
+
+    To list all previews filtered by metadata using single
+    label, run:
+
+        $ uffizzi preview list --filter github.repo=my_repo
+
+    To list all previews filtered by metadata using multiple
+    labels, run:
+
+        $ uffizzi preview list \
+        --filter="github.repo=my_repo github.pull_request.number=23"

data/man/uffizzi-preview-update

@@ -1,8 +1,8 @@
 .\" generated with Ronn-NG/v0.9.1
 .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
-.TH "UPDATE" "" "May 2022" ""
+.TH "UPDATE" "" "August 2022" ""
 .SH "NAME"
-\fBuffizzi preview update\fR \- update a preview
+\fBupdate\fR \- update a preview
 .SH "SYNOPSIS"
 .nf
 uffizzi preview update [PREVIEW_ID] [COMPOSE_FILE] [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
@@ -27,6 +27,12 @@ https://github\.com/UffizziCloud/uffizzi_cli
 [COMPOSE_FILE]
     The new compose file you want to preview\.
 .fi
+.SH "FLAGS"
+.nf
+\-\-set\-labels=METADATA
+    Metadata of deployment that contains any information which can
+    be usefull for filtering deployments\.
+.fi
 .SH "UFFIZZI WIDE FLAGS"
 .nf
 These flags are available to all commands: \-\-project\. Run $ uffizzi
@@ -38,5 +44,17 @@ The following command updates a preview with ID deployment\-67 using
 compose file docker\-compose\.alt\.yml:
 
     $ uffizzi preview update deployment\-67 docker\-compose\.alt\.yml
+
+To update a preview with single label, run:
+
+    $ uffizzi preview update \e
+    deployment\-67 docker\-compose\.alt\.yml \e
+    \-\-set\-labels github\.repo=my_repo
+
+To update a preview with multiple labels, run:
+
+    $ uffizzi preview update \e
+    deployment\-67 docker\-compose\.alt\.yml \e
+    \-\-set\-labels="github\.repo=my_repo github\.pull_request\.number=23"
 .fi
 

data/man/uffizzi-preview-update.ronn

@@ -22,6 +22,11 @@ uffizzi preview update - update a preview
     [COMPOSE_FILE]
         The new compose file you want to preview.
 
+## FLAGS
+    --set-labels=METADATA
+        Metadata of deployment that contains any information which can
+        be usefull for filtering deployments.
+
 ## UFFIZZI WIDE FLAGS
     These flags are available to all commands: --project. Run $ uffizzi 
     help for details.
@@ -31,3 +36,15 @@ uffizzi preview update - update a preview
     compose file docker-compose.alt.yml:
 
         $ uffizzi preview update deployment-67 docker-compose.alt.yml
+
+    To update a preview with single label, run:
+
+        $ uffizzi preview update \
+        deployment-67 docker-compose.alt.yml \
+        --set-labels github.repo=my_repo
+
+    To update a preview with multiple labels, run:
+
+        $ uffizzi preview update \
+        deployment-67 docker-compose.alt.yml \
+        --set-labels="github.repo=my_repo github.pull_request.number=23"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: uffizzi-cli
 version: !ruby/object:Gem::Version
-  version: 0.11.4
+  version: 0.14.0
 platform: ruby
 authors:
 - Josh Thurman
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-07-28 00:00:00.000000000 Z
+date: 2022-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -337,6 +337,7 @@ files:
 - lib/uffizzi/config_file.rb
 - lib/uffizzi/date_helper.rb
 - lib/uffizzi/error.rb
+- lib/uffizzi/helpers/connect_helper.rb
 - lib/uffizzi/helpers/project_helper.rb
 - lib/uffizzi/promt.rb
 - lib/uffizzi/response_helper.rb
@@ -355,6 +356,8 @@ files:
 - man/uffizzi-connect-acr.ronn
 - man/uffizzi-connect-docker-hub
 - man/uffizzi-connect-docker-hub.ronn
+- man/uffizzi-connect-docker-registry
+- man/uffizzi-connect-docker-registry.ronn
 - man/uffizzi-connect-ecr
 - man/uffizzi-connect-ecr.ronn
 - man/uffizzi-connect-gcr