From 93e9580a0de7924f59bc1462651ed041da93c245 Mon Sep 17 00:00:00 2001 From: Elara Date: Mon, 15 Apr 2024 21:32:27 +0000 Subject: [PATCH] Add woodpecker docs [skip ci] --- docs.md | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 docs.md diff --git a/docs.md b/docs.md new file mode 100644 index 0000000..9f12ff0 --- /dev/null +++ b/docs.md @@ -0,0 +1,33 @@ +--- +name: Twine +description: Publish a built python project to a PyPi repository +author: Elara6331 +containerImage: gitea.elara.ws/music-kraken/plugin-twine +containerImageUrl: https://gitea.elara.ws/music-kraken/-/packages/container/plugin-twine/latest +url: https://gitea.elara.ws/music-kraken/plugin-twine +tags: [python, pypi, twine] +--- + +Woodpecker CI plugin that uses the [Twine](https://github.com/pypa/twine/) utility to publish a built Python project to a PyPi repository. + +## Settings + +- `username`: The username to authenticate to the repository as. (REQUIRED) +- `password`: The password to authenticate to the repository with. (REQUIRED) +- `comment`: The comment to include with the distribution file. +- `repository_url`: The repository URL to upload the package to. + +## Example + +```yaml +steps: + publish: + image: gitea.elara.ws/music-kraken/plugin-twine + settings: + repository_url: "https://gitea.elara.ws/api/packages/music-kraken/pypi" + username: + from_secret: pypi_username + password: + from_secret: pypi_password +``` +