From 46430e6402f8b2975ff9b0627faca6f154328e5f Mon Sep 17 00:00:00 2001
From: James Lamb <jlamb@nvidia.com>
Date: Wed, 13 Nov 2024 13:42:20 -0600
Subject: [PATCH] enforce wheel size limits, README formatting in CI (#208)

## Description

Contributes to https://github.com/rapidsai/build-planning/issues/110

Proposes adding 2 types of validation on wheels in CI, to ensure we
continue to produce wheels that are suitable for PyPI.

* checks on wheel size (compressed),
  - *to be sure they're under PyPI limits*
- *and to prompt discussion on PRs that significantly increase wheel
sizes*
* checks on README formatting
  - *to ensure they'll render properly as the PyPI project homepages*
- *e.g. like how
https://github.com/scikit-learn/scikit-learn/blob/main/README.rst
becomes https://pypi.org/project/scikit-learn/*
---
 ci/build_wheel.sh    |  2 ++
 ci/validate_wheel.sh | 18 ++++++++++++++++++
 pyproject.toml       |  8 ++++++++
 3 files changed, 28 insertions(+)
 create mode 100755 ci/validate_wheel.sh

diff --git a/ci/build_wheel.sh b/ci/build_wheel.sh
index 773e6c3..dd552c4 100755
--- a/ci/build_wheel.sh
+++ b/ci/build_wheel.sh
@@ -38,6 +38,8 @@ python -m pip install build
 # Build the Python package
 python -m build -s -w
 
+ci/validate_wheel.sh dist
+
 rapids-logger "Uploading JupyterLab NVDashboard wheels to S3"
 # Upload Python wheels to S3
 RAPIDS_PY_WHEEL_NAME="${package_name}" RAPIDS_PY_WHEEL_PURE="1" rapids-upload-wheels-to-s3 dist
diff --git a/ci/validate_wheel.sh b/ci/validate_wheel.sh
new file mode 100755
index 0000000..60a80fc
--- /dev/null
+++ b/ci/validate_wheel.sh
@@ -0,0 +1,18 @@
+#!/bin/bash
+# Copyright (c) 2024, NVIDIA CORPORATION.
+
+set -euo pipefail
+
+wheel_dir_relative_path=$1
+
+rapids-logger "validate packages with 'pydistcheck'"
+
+pydistcheck \
+    --inspect \
+    "$(echo ${wheel_dir_relative_path}/*.whl)"
+
+rapids-logger "validate packages with 'twine'"
+
+twine check \
+    --strict \
+    "$(echo ${wheel_dir_relative_path}/*.whl)"
diff --git a/pyproject.toml b/pyproject.toml
index dfdf6c8..1e44230 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -114,3 +114,11 @@ force-exclude = '''
     package.json
 )/
 '''
+
+[tool.pydistcheck]
+select = [
+    "distro-too-large-compressed",
+]
+
+# PyPI limit is 100 MiB, fail CI before we get too close to that
+max_allowed_size_compressed = '75M'