Use Local PyPI Server for Dry Run

Author: jtpio

.github/workflows/check-release.yml

@@ -3,17 +3,16 @@ on:
   push:
     branches: ["*"]
 
-permissions:
-  contents: write
-
 jobs:
   check_release:
     runs-on: ubuntu-latest
+    permissions:
+      contents: write
     steps:
       - name: Checkout
-        uses: actions/checkout@v1
+        uses: actions/checkout@v2
       - name: Install Python
-        uses: actions/setup-python@v1
+        uses: actions/setup-python@v2
         with:
           python-version: 3.9
           architecture: "x64"
@@ -22,7 +21,7 @@ jobs:
         run: |
           echo "::set-output name=dir::$(pip cache dir)"
       - name: Cache pip
-        uses: actions/cache@v1
+        uses: actions/cache@v2
         with:
           path: ${{ steps.pip-cache.outputs.dir }}
           key: ${{ runner.os }}-pip-${{ hashFiles('setup.cfg') }}
@@ -43,8 +42,6 @@ jobs:
         run: |
           pip install -e .
       - name: Check Release
-        env:
-          TWINE_PASSWORD: ${{ secrets.TEST_PYPI_TOKEN }}
         uses: ./.github/actions/check-release
         with:
           token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/draft-changelog.yml

@@ -20,9 +20,9 @@ jobs:
         python-version: ["3.9"]
     steps:
       - name: Checkout
-        uses: actions/checkout@v1
+        uses: actions/checkout@v2
       - name: Install Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v1
+        uses: actions/setup-python@v2
         with:
           python-version: ${{ matrix.python-version }}
           architecture: "x64"

.github/workflows/draft-release.yml

@@ -26,27 +26,15 @@ jobs:
       POST_VERSION_SPEC: ${{ github.event.inputs.post_version_spec }}
     steps:
       - name: Checkout
-        uses: actions/checkout@v1
+        uses: actions/checkout@v2
       - name: Install Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v1
+        uses: actions/setup-python@v2
         with:
           python-version: ${{ matrix.python-version }}
           architecture: "x64"
       - name: Upgrade packaging dependencies
         run: |
           pip install --upgrade pip setuptools wheel --user
-      - name: Get pip cache dir
-        id: pip-cache
-        run: |
-          echo "::set-output name=dir::$(pip cache dir)"
-      - name: Cache pip
-        uses: actions/cache@v1
-        with:
-          path: ${{ steps.pip-cache.outputs.dir }}
-          key: ${{ runner.os }}-pip-${{ matrix.python-version }}-${{ hashFiles('setup.py') }}
-          restore-keys: |
-            ${{ runner.os }}-pip-${{ matrix.python-version }}-
-            ${{ runner.os }}-pip-
       - name: Install Dependencies
         run: |
           pip install -e .

.github/workflows/publish-release.yml

@@ -14,24 +14,12 @@ jobs:
         with:
           access_token: ${{ github.token }}
       - name: Checkout
-        uses: actions/checkout@v1
+        uses: actions/checkout@v2
       - name: Install Python
-        uses: actions/setup-python@v1
+        uses: actions/setup-python@v2
         with:
           python-version: 3.9
           architecture: "x64"
-      - name: Get pip cache dir
-        id: pip-cache
-        run: |
-          echo "::set-output name=dir::$(pip cache dir)"
-      - name: Cache pip
-        uses: actions/cache@v1
-        with:
-          path: ${{ steps.pip-cache.outputs.dir }}
-          key: ${{ runner.os }}-pip-${{ hashFiles('setup.cfg') }}
-          restore-keys: |
-            ${{ runner.os }}-pip-
-            ${{ runner.os }}-pip-
       - name: Upgrade packaging dependencies
         run: |
           pip install --upgrade pip setuptools wheel --user

.github/workflows/test.yml

@@ -42,16 +42,16 @@ jobs:
         with:
           access_token: ${{ github.token }}
       - name: Checkout
-        uses: actions/checkout@v1
+        uses: actions/checkout@v2
       - name: Install Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v1
+        uses: actions/setup-python@v2
         with:
           python-version: ${{ matrix.python-version }}
           architecture: "x64"
       - name: Set up Node
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v2
         with:
-          node-version: "12.x"
+          node-version: "14.x"
       - run: git --version
       - name: Upgrade packaging dependencies
         run: |
@@ -61,7 +61,7 @@ jobs:
         run: |
           echo "::set-output name=dir::$(pip cache dir)"
       - name: Cache pip
-        uses: actions/cache@v1
+        uses: actions/cache@v2
         with:
           path: ${{ steps.pip-cache.outputs.dir }}
           key: ${{ runner.os }}-pip-${{ matrix.python-version }}-${{ hashFiles('setup.cfg') }}

README.md

@@ -184,8 +184,6 @@ version_info = get_version_info(__version__)
 - name: Check Release
   if: ${{ matrix.python-version == '3.9' }}
   uses: jupyter-server/jupyter_releaser/.github/actions/check-release@v1
-  env:
-    TWINE_PASSWORD: ${{ secrets.TEST_PYPI_TOKEN }}
   with:
     token: ${{ secrets.GITHUB_TOKEN }}
 ```

jupyter_releaser/actions/publish_release.py

@@ -1,17 +1,14 @@
 # Copyright (c) Jupyter Development Team.
 # Distributed under the terms of the Modified BSD License.
+import atexit
 import os
+from subprocess import Popen
+from tempfile import TemporaryDirectory
 
+from jupyter_releaser.util import CHECKOUT_NAME
 from jupyter_releaser.util import run
 
-
 os.environ.setdefault("TWINE_USERNAME", "__token__")
-
-if os.environ.get("RH_DRY_RUN") == "true":
-    os.environ.setdefault("TWINE_COMMAND", "twine upload --skip-existing")
-    os.environ.setdefault("TWINE_REPOSITORY_URL", "https://test.pypi.org/legacy/")
-    os.environ.setdefault("RH_NPM_COMMAND", "npm publish --dry-run")
-
 release_url = os.environ["release_url"]
 run(f"jupyter-releaser extract-release {release_url}")
 run(f"jupyter-releaser forwardport-changelog {release_url}")

jupyter_releaser/cli.py

@@ -35,7 +35,7 @@ def invoke(self, ctx):
                             envvars[param.name] = param.envvar
 
             for key in sorted(envvars):
-                print(f"{key.replace('_', '-')}: {envvars[key]}")
+                util.log(f"{key.replace('_', '-')}: {envvars[key]}")
 
             return
 
@@ -52,9 +52,9 @@ def invoke(self, ctx):
         options = config.get("options", {})
 
         # Print a separation header
-        print(f'\n\n{"-" * 50}')
-        print(cmd_name)
-        print(f'{"-" * 50}\n\n')
+        util.log(f'\n\n{"-" * 50}')
+        util.log(cmd_name)
+        util.log(f'{"-" * 50}\n\n')
 
         # Handle all of the parameters
         for param in self.commands[cmd_name].get_params(ctx):
@@ -412,7 +412,6 @@ def draft_release(
 @main.command()
 @add_options(auth_options)
 @click.argument("release-url", nargs=1)
-@use_checkout_dir()
 def delete_release(auth, release_url):
     """Delete a draft GitHub release by url to the release page"""
     lib.delete_release(auth, release_url)

jupyter_releaser/lib.py

@@ -1,14 +1,18 @@
 # Copyright (c) Jupyter Development Team.
 # Distributed under the terms of the Modified BSD License.
+import atexit
 import os
 import os.path as osp
 import re
+import shlex
 import shutil
 import sys
 import uuid
 from datetime import datetime
 from glob import glob
 from pathlib import Path
+from subprocess import PIPE
+from subprocess import Popen
 from tempfile import TemporaryDirectory
 
 import requests
@@ -348,6 +352,25 @@ def publish_release(
     """Publish release asset(s) and finalize GitHub release"""
     util.log(f"Publishing {release_url} in with dry run: {dry_run}")
 
+    if dry_run:
+        # Start local pypi server with no auth, allowing overwrites,
+        # in a temporary directory
+        temp_dir = TemporaryDirectory()
+        cmd = f"pypi-server -p 8081  -P . -a . -o  -v {temp_dir.name}"
+        proc = Popen(shlex.split(cmd), stderr=PIPE)
+        # Wait for the server to start
+        while True:
+            line = proc.stderr.readline().decode("utf-8").strip()
+            util.log(line)
+            if "Listening on" in line:
+                break
+        atexit.register(proc.kill)
+        atexit.register(temp_dir.cleanup)
+        twine_cmd = "twine upload --repository-url=http://localhost:8081"
+        os.environ["TWINE_USERNAME"] = "foo"
+        os.environ["TWINE_PASSWORD"] = "bar"
+        npm_cmd = "npm publish --dry-run"
+
     match = parse_release_url(release_url)
 
     if npm_token:
@@ -387,7 +410,7 @@ def publish_release(
     util.actions_output("release_url", release.html_url)
 
 
-def prep_git(branch, repo, auth, username, url):
+def prep_git(branch, repo, auth, username, url, install=True):
     """Set up git"""
     repo = repo or util.get_repo()
 
@@ -409,7 +432,7 @@ def prep_git(branch, repo, auth, username, url):
     checkout_dir = os.environ.get("RH_CHECKOUT_DIR", util.CHECKOUT_NAME)
     checkout_exists = False
     if osp.exists(osp.join(checkout_dir, ".git")):
-        print("Git checkout already exists", file=sys.stderr)
+        util.log("Git checkout already exists")
         checkout_exists = True
 
     if not checkout_exists:
@@ -440,7 +463,7 @@ def prep_git(branch, repo, auth, username, url):
     util.run(f"git checkout {branch}")
 
     # Install the package with test deps
-    if util.SETUP_PY.exists():
+    if util.SETUP_PY.exists() and install:
         util.run('pip install ".[test]"')
 
     os.chdir(orig_dir)
@@ -459,8 +482,10 @@ def forwardport_changelog(
     tag = release.tag_name
 
     repo = f'{match["owner"]}/{match["repo"]}'
+
     # We want to target the main branch
-    branch = prep_git(None, repo, auth, username, git_url)
+    orig_dir = os.getcwd()
+    branch = prep_git(None, repo, auth, username, git_url, install=False)
     os.chdir(util.CHECKOUT_NAME)
 
     # Bail if the tag has been merged to the branch
@@ -520,3 +545,7 @@ def forwardport_changelog(
     pr = make_changelog_pr(
         auth, branch, repo, title, commit_message, body, dry_run=dry_run
     )
+
+    # Clean up after ourselves
+    os.chdir(orig_dir)
+    shutil.rmtree(util.CHECKOUT_NAME)

jupyter_releaser/tests/test_cli.py

@@ -464,23 +464,29 @@ def helper(path, **kwargs):
     assert len(get_mock.mock_calls) == len(dist_names) == 3
 
 
-def test_publish_release_py(py_dist, runner, mocker, open_mock):
+@pytest.mark.skipif(
+    os.name == "nt", reason="pypiserver does not start properly on Windows"
+)
+def test_publish_release_py(py_package, runner, mocker, open_mock, git_prep):
     open_mock.side_effect = [MockHTTPResponse([REPO_DATA]), MockHTTPResponse()]
 
+    # Create the dist files
+    changelog_entry = mock_changelog_entry(py_package, runner, mocker)
+    run("python -m build .", cwd=util.CHECKOUT_NAME)
+
     orig_run = util.run
     called = 0
 
     def wrapped(cmd, **kwargs):
         nonlocal called
         if cmd.startswith("twine upload"):
             called += 1
-            return ""
         return orig_run(cmd, **kwargs)
 
     mock_run = mocker.patch("jupyter_releaser.util.run", wraps=wrapped)
 
-    dist_dir = py_dist / util.CHECKOUT_NAME / "dist"
-    runner(["publish-release", HTML_URL, "--dist-dir", dist_dir])
+    dist_dir = py_package / util.CHECKOUT_NAME / "dist"
+    runner(["publish-release", HTML_URL, "--dist-dir", dist_dir, "--dry-run"])
     assert len(open_mock.call_args) == 2
     assert called == 2, called