From c472fba3606b9ae469ed16f989c7858fea8ab1fd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andr=C3=A9=20Roth?= Date: Tue, 15 Oct 2024 13:59:22 +0200 Subject: [PATCH] update doc --- docs/Publish.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/Publish.md b/docs/Publish.md index d87c87cc7..b99a2cc89 100644 --- a/docs/Publish.md +++ b/docs/Publish.md @@ -26,4 +26,12 @@ repositories. Signing releases is highly recommended, but if you want to skip it, you can either use `gpgDisableSign` configuration option or `--skip-signing` flag. + +#### Parameters + +Publish APIs use following convention to identify published repositories: `/api/publish/:prefix/:distribution`. +`:distribution` is distribution name, while `:prefix` is `[:]` (storage is optional, it defaults +to empty string), if publishing prefix contains slashes `/`, they should be replaced with underscores (`_`) and underscores +should be replaced with double underscore (`__`). To specify root `:prefix`, use `:.`, as `.` is ambigious in URLs. +