From b0ecbb6fbcf86b21070a0d04be7f8f4ee86705c6 Mon Sep 17 00:00:00 2001 From: Benjamin Renard Date: Mon, 2 May 2022 16:12:52 +0200 Subject: [PATCH] Add README --- README.md | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..533bfca --- /dev/null +++ b/README.md @@ -0,0 +1,36 @@ +# Woodpecker CI plugin to publish Debian package on a Aptly repository + +This docker image could be used as an Woodpecker CI plugin to publish one (or more) Debian package on a Aptly repository using its API. + +This plugin will try to : +- locate all `changes` files in the `dist` directory (that matched `source_name` if provided) +- extract files that are mentioned by the changes files and upload it using Aptly files API. Files are published on a subdirectory of the name of the source package +- include all processed changes files using Aplty repos API +- create a snapshot of the repository named using current datetime and repository name (format: `YYYYMMDD-HHMMSS-repo`) using Aptly snapshot API +- update the published snapshot of the repository using Aptly publish API + +# Usage + +The below pipeline configuration demonstrates simple usage: + +``` +pipeline: + publish: + image: brenard/aptly-publish + settings: + api_url: https://your.aptly.tld/api + api_username: myproject + api_password: + from_secret: aptly_api_password + repo_name: stable + path: dist + source_name: myproject +``` + +__Parameters:__ +- __api_url:__ Your Aptly API URL (required) +- __api_username:__ Username to authenticate on your Aptly API (required) +- __api_password:__ Password to authenticate on your Aptly API (required) +- __repo_name:__ Repository name to publish on (optional, default: `stable`) +- __path:__ Path to the directory where files to publish are stored (optional, default: `dist`) +- __source_name:__ Name of the source package to publish (optional, default: all `changes` files are will be publish)