From 97f83b6279674e65a8da2167fc262958128a40bb Mon Sep 17 00:00:00 2001 From: Nikolay Soloviev Date: Fri, 7 Apr 2023 10:53:59 +0400 Subject: [PATCH 1/5] Update trigger-deploy.yml ubuntu-latest --- .github/workflows/trigger-deploy.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/trigger-deploy.yml b/.github/workflows/trigger-deploy.yml index 176cc12..d8ddff0 100644 --- a/.github/workflows/trigger-deploy.yml +++ b/.github/workflows/trigger-deploy.yml @@ -14,7 +14,7 @@ on: jobs: trigger-zpm-deployment: name: Trigger zpm-registry-deployment via REST API - runs-on: ubuntu-18.04 + runs-on: ubuntu-latest steps: - name: REST POST call From 6831c2501f29deb1a381138d21c4b8482d396d62 Mon Sep 17 00:00:00 2001 From: ProjectBot Date: Fri, 7 Apr 2023 06:54:12 +0000 Subject: [PATCH 2/5] auto bump version --- module.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/module.xml b/module.xml index a358718..3c25fbf 100644 --- a/module.xml +++ b/module.xml @@ -5,7 +5,7 @@ zpm-registry ZPM Registry Registry server for ZPM - 1.2.4 + 1.2.5 module From 71294f23d650af98054e0f273784ee0709894a8e Mon Sep 17 00:00:00 2001 From: Nikolay Solovyev Date: Mon, 7 Aug 2023 10:43:55 +0400 Subject: [PATCH 3/5] readme updated (uplinks & delete) --- README.md | 47 ++++++++++++++++++++++++++++++++++++++++------- 1 file changed, 40 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 1a74c55..0235772 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # intersystems zpm-registry -[![Quality Gate Status](https://community.objectscriptquality.com/api/project_badges/measure?project=intersystems_iris_community%2Fzpm-registry&metric=alert_status)](https://community.objectscriptquality.com/dashboard?id=intersystems_iris_community%2Fzpm-registry) +[![Quality Gate Status](https://community.objectscriptquality.com/api/project_badges/measure?project=intersystems_iris_community%2Fzpm-registry&metric=alert_status)](https://community.objectscriptquality.com/dashboard?id=intersystems_iris_community%2Fzpm-registry) ZPM Registry is a a server part of ObjectScript Package Manager. @@ -13,26 +13,59 @@ You can use ZPM Registry project to build your own private registry to have the ZPM Registry works only on IRIS and IRIS For Health, community and Enterprise versions. # Installation -## Usual Installation -Import classes from cls and run Installer from Root + +## ZPM Installation +`install zpm-registry` ## Docker Installation Build docker container -## ZPM Installation -`install zpm-registry` +## Usual Installation +Import classes from cls and run Installer from Root # Usage ZPM Registry exposes REST API, which perfoms listing, publising and deployment services. You can examine the REST in the source class [Registry.cls](https://github.com/intersystems-community/zpm-registry/blob/master/src/cls/ZPM/Registry.cls) or via Swagger -Note, when you publish the repo via API you need to provide the GIthub URL of the repo, which will contain module.xml. +Note, when you publish the repo via API you need to provide the Github URL of the repo, which will contain module.xml. And published package will remember the repository and will not allow to publish/update package with the same name but with another repository. ## Working With Your Registry From ZPM Client You can setup ZPM client to work with your registry with the following command: ``` -ZPM:USER>repo -n registry -r -url https://registry.yourdomain.com +zpm:USER>repo -n registry -r -url https://registry.yourdomain.com +``` + +## Settings +To configure the registry, utilize the zpm-registry.yaml file located within the IRIS installation folder. Retrieve the IRIS directory in which the file should reside using the following command: write ##class(%SYSTEM.Util).InstallDirectory(). + + +## Proxy-Registry +Starting from version 1.1.2, zpm-registry includes the Proxy feature. +This allows the IPM client to use only your private registry and install packages from your private registry, all the while retaining the capability to install packages from an external registry (Uplink). + +External registries that your local registry can access are called Uplinks. You can define one or more external registries. You can also list which packages from the Uplink registry should be available. + +These settings are set in the `zpm-registry.yaml` file. + +Settings file example: +``` +uplinks: + pm: + url: https://pm.community.intersystems.com/ + allow_packages: dsw,zpm*,?u* +``` + +For more information, see https://community.intersystems.com/post/new-zpm-registry-feature-%E2%80%93-proxy-registry + + +## Delete packages +Starting from version 0.7, IPM introduces support for the "unpublish" command, which facilitates the removal of a package that was previously published. +In order for this command to be executed, it is necessary to explicitly allow the removal of packages on the side of the registry. To do this, add the line "delete-enabled: true" to the settings file `zpm-registry.yaml` + +Settings file example: +``` +delete-enabled: true ``` From 223f16c9ae31d659ceb0e128c0eda2aeb4236397 Mon Sep 17 00:00:00 2001 From: Nikolay Soloviev Date: Mon, 7 Aug 2023 10:45:12 +0400 Subject: [PATCH 4/5] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 0235772..6f044db 100644 --- a/README.md +++ b/README.md @@ -37,7 +37,7 @@ zpm:USER>repo -n registry -r -url https://registry.yourdomain.com ``` ## Settings -To configure the registry, utilize the zpm-registry.yaml file located within the IRIS installation folder. Retrieve the IRIS directory in which the file should reside using the following command: write ##class(%SYSTEM.Util).InstallDirectory(). +To configure the registry, utilize the zpm-registry.yaml file located within the IRIS installation folder. Retrieve the IRIS directory in which the file should reside using the following command: `write ##class(%SYSTEM.Util).InstallDirectory()`. ## Proxy-Registry From 336b9b188ff71fc1c3705a2dc4ab93117814edf2 Mon Sep 17 00:00:00 2001 From: ProjectBot Date: Mon, 7 Aug 2023 06:57:49 +0000 Subject: [PATCH 5/5] auto bump version --- module.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/module.xml b/module.xml index 3c25fbf..366fe73 100644 --- a/module.xml +++ b/module.xml @@ -5,7 +5,7 @@ zpm-registry ZPM Registry Registry server for ZPM - 1.2.5 + 1.2.6 module