From 48259af24d3fd5d206149c5286ff71a77c7546dd Mon Sep 17 00:00:00 2001 From: Sviatoslav Sydorenko Date: Thu, 12 Sep 2019 14:06:55 +0200 Subject: [PATCH] Add a Non-goals section to the README --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index 05c81cd..0358488 100644 --- a/README.md +++ b/README.md @@ -45,6 +45,13 @@ The secret used in `${{ secrets.pypi_password }}` needs to be created on the set page of your project on GitHub. See [Creating & using secrets]. +## Non-goals + +This GitHub Action [has nothing to do with _building package +distributions_]. Users are responsible for preparing dists for upload +by putting them into the `dist/` folder prior to running this Action. + + ## License The Dockerfile and associated scripts and documentation in this project @@ -52,3 +59,5 @@ are released under the [BSD 3-clause license](LICENSE.md). [Creating & using secrets]: https://help.github.com/en/articles/virtual-environments-for-github-actions#creating-and-using-secrets-encrypted-variables +[has nothing to do with _building package distributions_]: +https://github.com/pypa/gh-action-pypi-publish/issues/11#issuecomment-530480449