diff --git a/doc/source/artifacts.rst b/doc/source/artifacts.rst index 70b77f39..5dc0b6ea 100644 --- a/doc/source/artifacts.rst +++ b/doc/source/artifacts.rst @@ -71,10 +71,10 @@ to meet requirements.:: repositories: # Optional field. global: revision: 47676764d3935e4934624bf9593e9115984fe668 - url: ssh://REPO_USERNAME@gerrit:29418/aic-clcp-manifests.git + url: ssh://REPO_USERNAME@:29418/global-manifests.git secrets: revision: master - url: ssh://REPO_USERNAME@gerrit:29418/aic-clcp-security-manifests.git + url: ssh://REPO_USERNAME@:29418/security-manifests.git The ``repositories`` field (optional) maps default authentication information for each of the manifests repositories supported, for example: @@ -94,7 +94,7 @@ Each of the above fields must have 2 pieces of information: * REPO_USERNAME - must be included for ssh only. Can be overridden with the CLI via :ref:`command-line-repository-overrides`. * port - e.g. 29418 - must be included for ssh only. - * repository name - e.g. aic-clcp-manifests + * repository name Self-Contained Repository ^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/doc/source/cli/cli.rst b/doc/source/cli/cli.rst index 98f3283f..6820a344 100644 --- a/doc/source/cli/cli.rst +++ b/doc/source/cli/cli.rst @@ -209,10 +209,10 @@ Example usage: :: - ./pegleg.sh site -r /opt/aic-clcp-site-manifests/ \ + ./pegleg.sh site -r /opt/site-manifests/ \ -u \ - -k /opt/.ssh/gerrit.pub \ - -e global=ssh://REPO_USERNAME@:29418/aic-clcp-manifests.git@master \ + -k /opt/.ssh/git.pub \ + -e global=ssh://REPO_USERNAME@:29418/global-manifests.git@master \ Collect @@ -258,16 +258,16 @@ Example without validation: :: - ./pegleg.sh site -r /opt/aic-clcp-site-manifests \ - -e global=/opt/aic-clcp-manifests \ + ./pegleg.sh site -r /opt/site-manifests \ + -e global=/opt/manifests \ collect -s /workspace Example with validation: :: - ./pegleg.sh site -r /opt/aic-clcp-site-manifests \ - -e global=/opt/aic-clcp-manifests \ + ./pegleg.sh site -r /opt/site-manifests \ + -e global=/opt/manifests \ collect -s /workspace -x P004 --validate List @@ -292,7 +292,7 @@ Example: :: - ./pegleg site -r /opt/aic-clcp-site-manifests list -o /workspace + ./pegleg site -r /opt/site-manifests list -o /workspace Show ---- @@ -320,7 +320,7 @@ Example: :: - ./pegleg site -r /opt/aic-clcp-site-manifests show site_name -o /workspace + ./pegleg site -r /opt/site-manifests show site_name -o /workspace Render ------ @@ -348,7 +348,7 @@ Example: :: - ./pegleg site -r /opt/aic-clcp-site-manifests render site_name -o output + ./pegleg site -r /opt/site-manifests render site_name -o output .. _cli-site-lint: @@ -384,8 +384,8 @@ A more complex example involves excluding certain linting checks: :: - ./pegleg.sh site -r /opt/aic-clcp-site-manifests \ - -e global=/opt/aic-clcp-manifests \ + ./pegleg.sh site -r /opt/site-manifests \ + -e global=/opt/manifests \ lint \ -x P001 -x P002 -w P003 @@ -413,8 +413,8 @@ Where: recommended * url (fully qualified) - must have following formats: - * ssh - ://@:/.git - * http|https - :///.git + * ssh - ://@:/.git + * http|https - :///.git Where: @@ -423,11 +423,11 @@ Where: This value will replace the literal string REPO_USERNAME in the corresponding entry under the ``repositories`` field in the relevant :file:`site-definition.yaml` using ``-u`` CLI flag - * must be a valid Gerrit URL + * must be a valid Git URL * must be a valid authentication port for SSH * must be a valid :ref:`git-reference` * must be a valid Git repository name, - e.g. aic-clcp-site-manifests + e.g. site-manifests .. _self-contained-repo: diff --git a/pegleg/engine/repository.py b/pegleg/engine/repository.py index fcea6047..00c09c49 100644 --- a/pegleg/engine/repository.py +++ b/pegleg/engine/repository.py @@ -176,9 +176,9 @@ def _process_site_repository(repo_url_or_path, repo_revision): :param repo_url_or_path: Repo path or URL and associated auth information. If URL, examples include: - * ssh://REPO_USERNAME@:29418/aic-clcp-manifests.git@ - * https:///aic-clcp-manifests.git@ - * http:///aic-clcp-manifests.git@ + * ssh://REPO_USERNAME@:29418/global-manifests.git@ + * https:///global-manifests.git@ + * http:///global-manifests.git@ * @ * same values as above without @ :param str repo_revision: branch, commit or ref in the repo to checkout. @@ -276,9 +276,9 @@ def _extract_repo_url_and_revision(repo_url_or_path): :param repo_url_or_path: Repo URL and associated auth information. E.g.: - * ssh://REPO_USERNAME@:29418/aic-clcp-manifests.git@ - * https:///aic-clcp-manifests.git@ - * http:///aic-clcp-manifests.git@ + * ssh://REPO_USERNAME@:29418/global-manifests.git@ + * https:///global-manifests.git@ + * http:///global-manifests.git@ * @ * same values as above without @