fix(release): minimum needed to run twine to publish

alexeagle · alexeagle · commit e3a7e48b045c · 2023-01-26T15:58:30.000-08:00
Earlier attempts to publish 0.17 have failed mysteriously at the pypa/gh-action-pypi-publish step. This PR replaces that with a command that I can test locally. TWINE_USERNAME=__token__ TWINE_PASSWORD=pypi-*** bazel run --stamp --embed_label=1.2.4 //python/runfiles:wheel.publish -- --repository testpypi Uploading bazel_runfiles-1.2.4-py3-none-any.whl 100% ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 11.0/11.0 kB • 00:00 • 27.3 MB/s View at: https://test.pypi.org/project/bazel-runfiles/1.2.4/
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -14,16 +14,15 @@ jobs:
         uses: actions/checkout@v2
       - name: Prepare workspace snippet
         run: .github/workflows/workspace_snippet.sh > release_notes.txt
-      - name: Build wheel dist
-        run: bazel build --stamp --embed_label=${{ github.ref_name }} //python/runfiles:wheel.dist
-      - name: Publish runfiles package to PyPI
-        uses: pypa/gh-action-pypi-publish@release/v1
-        with:
+      - name: Publish wheel dist
+        env:
+          # This special value tells pypi that the user identity is supplied within the token
+          TWINE_USERNAME: __token__
           # Note, the PYPI_API_TOKEN was added on
           # https://github.com/bazelbuild/rules_python/settings/secrets/actions 
           # and currently uses a token which authenticates as https://pypi.org/user/alexeagle/
-          password: ${{ secrets.PYPI_API_TOKEN }}
-          packages_dir: bazel-bin/python/runfiles/dist
+          TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
+        run: bazel run --stamp --embed_label=${{ github.ref_name }} //python/runfiles:wheel.publish
       - name: Release
         uses: softprops/action-gh-release@v1
         with:
diff --git a/WORKSPACE b/WORKSPACE
@@ -67,3 +67,21 @@ load("@rules_python_gazelle_plugin//:deps.bzl", _py_gazelle_deps = "gazelle_deps
 # This rule loads and compiles various go dependencies that running gazelle
 # for python requirements.
 _py_gazelle_deps()
+
+load("@python//3.11.1:defs.bzl", "interpreter")
+
+#####################
+# Install twine for our own runfiles wheel publishing
+# Eventually we might want to install twine automatically for users too, see:
+# See https://github.com/bazelbuild/rules_python/issues/1016
+load("@rules_python//python:pip.bzl", "pip_parse")
+
+pip_parse(
+    name = "publish_deps",
+    python_interpreter_target = interpreter,
+    requirements_lock = "//python/runfiles:requirements.txt",
+)
+
+load("@publish_deps//:requirements.bzl", "install_deps")
+
+install_deps()
diff --git a/python/runfiles/BUILD.bazel b/python/runfiles/BUILD.bazel
@@ -12,8 +12,14 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+load("@rules_python//python:defs.bzl", "py_binary")
 load("//python:defs.bzl", "py_library")
 load("//python:packaging.bzl", "py_wheel")
+load("//python:pip.bzl", "compile_pip_requirements")
+
+compile_pip_requirements(
+    name = "requirements",
+)
 
 filegroup(
     name = "distribution",
@@ -40,12 +46,27 @@ py_wheel(
         "Development Status :: 5 - Production/Stable",
         "License :: OSI Approved :: Apache Software License",
     ],
-    description_file = "README.md",
+    description_file = "README.rst",
     dist_folder = "dist",
     distribution = "bazel_runfiles",
     homepage = "https://github.com/bazelbuild/rules_python",
     strip_path_prefixes = ["python"],
+    # this can be replaced by building with --stamp --embed_label=1.2.3
     version = "{BUILD_EMBED_LABEL}",
     visibility = ["//visibility:public"],
     deps = [":runfiles"],
 )
+
+# TODO(alexeagle): carry forward #1015 to make this part of the py_wheel macro
+py_binary(
+    name = "wheel.publish",
+    srcs = ["@publish_deps_twine//:rules_python_wheel_entry_point_twine.py"],
+    args = [
+        "upload",
+        "$(location :wheel.dist)/*",
+    ],
+    data = [":wheel.dist"],
+    imports = ["."],
+    main = "@publish_deps_twine//:rules_python_wheel_entry_point_twine.py",
+    deps = ["@publish_deps_twine//:pkg"],
+)
diff --git a/python/runfiles/README.rst b/python/runfiles/README.rst
@@ -1,26 +1,27 @@
-# bazel-runfiles library
+bazel-runfiles library
+======================
 
 This is a Bazel Runfiles lookup library for Bazel-built Python binaries and tests.
 
 Typical Usage
 -------------
 
 1.  Add the 'runfiles' dependency along with other third-party dependencies, for example in your
-    `requirements.txt` file.
+    ``requirements.txt`` file.
 
-2.  Depend on this runfiles library from your build rule, like you would other third-party libraries.
+2.  Depend on this runfiles library from your build rule, like you would other third-party libraries::
 
       py_binary(
           name = "my_binary",
           ...
           deps = [requirement("runfiles")],
       )
 
-3.  Import the runfiles library.
+3.  Import the runfiles library::
 
       import runfiles  # not "from runfiles import runfiles"
 
-4.  Create a Runfiles object and use rlocation to look up runfile paths:
+4.  Create a Runfiles object and use rlocation to look up runfile paths::
 
       r = runfiles.Create()
       ...
@@ -32,15 +33,15 @@ Typical Usage
     on the environment variables in os.environ. See `Create()` for more info.
 
     If you want to explicitly create a manifest- or directory-based
-    implementations, you can do so as follows:
+    implementations, you can do so as follows::
 
       r1 = runfiles.CreateManifestBased("path/to/foo.runfiles_manifest")
 
       r2 = runfiles.CreateDirectoryBased("path/to/foo.runfiles/")
 
-    If you wnat to start subprocesses, and the subprocess can't automatically
+    If you want to start subprocesses, and the subprocess can't automatically
     find the correct runfiles directory, you can explicitly set the right
-    environment variables for them:
+    environment variables for them::
 
       import subprocess
       import runfiles
diff --git a/python/runfiles/requirements.in b/python/runfiles/requirements.in
@@ -0,0 +1 @@
+twine
diff --git a/python/runfiles/requirements.txt b/python/runfiles/requirements.txt
