[BUG] Package Dir is No Longer Optional

[blink1073]

setuptools version

setuptools==61.0.0

Python version

Python 3.8.13

OS

macOS 12.3

Additional environment information

This is happening across python versions and operating systems in CI.

Description

Prior to setuptools 61.0.0, jupyter_releaser would properly include jupyter_releaser/schema.json in the wheel. It is now excluded. We had relied on MANIFEST.in and include_package_data=True.

If I explicitly add the following to the options table in setup.cfg it works, but we did not have to do so previously:

package_dir =
    "" = "jupyter_releaser"

The file is included in the sdist.

Expected behavior

We expect the package data to be included.

How to Reproduce

1. git clone git@github.com:jupyter-server/jupyter_releaser.git
2. cd jupyter_releaser
3. pip install build
4. python -m build --wheel

Output

* Creating virtualenv isolated environment...
* Installing packages in isolated environment... (setuptools>=40.8.0, wheel)
* Getting dependencies for wheel...
running egg_info
writing jupyter_releaser.egg-info/PKG-INFO
writing dependency_links to jupyter_releaser.egg-info/dependency_links.txt
writing entry points to jupyter_releaser.egg-info/entry_points.txt
writing requirements to jupyter_releaser.egg-info/requires.txt
writing top-level names to jupyter_releaser.egg-info/top_level.txt
reading manifest file 'jupyter_releaser.egg-info/SOURCES.txt'
reading manifest template 'MANIFEST.in'
no previously-included directories found matching 'media'
no previously-included directories found matching 'docs'
warning: no previously-included files found matching 'readthedocs.yml'
adding license file 'LICENSE'
writing manifest file 'jupyter_releaser.egg-info/SOURCES.txt'
* Installing packages in isolated environment... (wheel)
* Building wheel...
running bdist_wheel
running build
running build_py
creating build
creating build/lib
creating build/lib/jupyter_releaser
copying ./jupyter_releaser/tee.py -> build/lib/jupyter_releaser
copying ./jupyter_releaser/lib.py -> build/lib/jupyter_releaser
copying ./jupyter_releaser/util.py -> build/lib/jupyter_releaser
copying ./jupyter_releaser/__init__.py -> build/lib/jupyter_releaser
copying ./jupyter_releaser/npm.py -> build/lib/jupyter_releaser
copying ./jupyter_releaser/changelog.py -> build/lib/jupyter_releaser
copying ./jupyter_releaser/cli.py -> build/lib/jupyter_releaser
copying ./jupyter_releaser/python.py -> build/lib/jupyter_releaser
copying ./jupyter_releaser/__main__.py -> build/lib/jupyter_releaser
creating build/lib/jupyter_releaser/tests
copying ./jupyter_releaser/tests/conftest.py -> build/lib/jupyter_releaser/tests
copying ./jupyter_releaser/tests/util.py -> build/lib/jupyter_releaser/tests
copying ./jupyter_releaser/tests/__init__.py -> build/lib/jupyter_releaser/tests
copying ./jupyter_releaser/tests/test_functions.py -> build/lib/jupyter_releaser/tests
copying ./jupyter_releaser/tests/test_cli.py -> build/lib/jupyter_releaser/tests
creating build/lib/jupyter_releaser/actions
copying ./jupyter_releaser/actions/check_links.py -> build/lib/jupyter_releaser/actions
copying ./jupyter_releaser/actions/__init__.py -> build/lib/jupyter_releaser/actions
copying ./jupyter_releaser/actions/draft_release.py -> build/lib/jupyter_releaser/actions
copying ./jupyter_releaser/actions/generate-changelog.py -> build/lib/jupyter_releaser/actions
copying ./jupyter_releaser/actions/common.py -> build/lib/jupyter_releaser/actions
copying ./jupyter_releaser/actions/publish_release.py -> build/lib/jupyter_releaser/actions
copying ./jupyter_releaser/actions/draft_changelog.py -> build/lib/jupyter_releaser/actions
running egg_info
writing jupyter_releaser.egg-info/PKG-INFO
writing dependency_links to jupyter_releaser.egg-info/dependency_links.txt
writing entry points to jupyter_releaser.egg-info/entry_points.txt
writing requirements to jupyter_releaser.egg-info/requires.txt
writing top-level names to jupyter_releaser.egg-info/top_level.txt
reading manifest file 'jupyter_releaser.egg-info/SOURCES.txt'
reading manifest template 'MANIFEST.in'
no previously-included directories found matching 'media'
no previously-included directories found matching 'docs'
warning: no previously-included files found matching 'readthedocs.yml'
adding license file 'LICENSE'
writing manifest file 'jupyter_releaser.egg-info/SOURCES.txt'
installing to build/bdist.macosx-10.9-x86_64/wheel
running install
running install_lib
creating build/bdist.macosx-10.9-x86_64
creating build/bdist.macosx-10.9-x86_64/wheel
creating build/bdist.macosx-10.9-x86_64/wheel/jupyter_releaser
copying build/lib/jupyter_releaser/tee.py -> build/bdist.macosx-10.9-x86_64/wheel/jupyter_releaser
copying build/lib/jupyter_releaser/lib.py -> build/bdist.macosx-10.9-x86_64/wheel/jupyter_releaser
copying build/lib/jupyter_releaser/util.py -> build/bdist.macosx-10.9-x86_64/wheel/jupyter_releaser
creating build/bdist.macosx-10.9-x86_64/wheel/jupyter_releaser/tests
copying build/lib/jupyter_releaser/tests/conftest.py -> build/bdist.macosx-10.9-x86_64/wheel/jupyter_releaser/tests
copying build/lib/jupyter_releaser/tests/util.py -> build/bdist.macosx-10.9-x86_64/wheel/jupyter_releaser/tests
copying build/lib/jupyter_releaser/tests/__init__.py -> build/bdist.macosx-10.9-x86_64/wheel/jupyter_releaser/tests
copying build/lib/jupyter_releaser/tests/test_functions.py -> build/bdist.macosx-10.9-x86_64/wheel/jupyter_releaser/tests
copying build/lib/jupyter_releaser/tests/test_cli.py -> build/bdist.macosx-10.9-x86_64/wheel/jupyter_releaser/tests
copying build/lib/jupyter_releaser/__init__.py -> build/bdist.macosx-10.9-x86_64/wheel/jupyter_releaser
copying build/lib/jupyter_releaser/npm.py -> build/bdist.macosx-10.9-x86_64/wheel/jupyter_releaser
copying build/lib/jupyter_releaser/changelog.py -> build/bdist.macosx-10.9-x86_64/wheel/jupyter_releaser
copying build/lib/jupyter_releaser/cli.py -> build/bdist.macosx-10.9-x86_64/wheel/jupyter_releaser
creating build/bdist.macosx-10.9-x86_64/wheel/jupyter_releaser/actions
copying build/lib/jupyter_releaser/actions/check_links.py -> build/bdist.macosx-10.9-x86_64/wheel/jupyter_releaser/actions
copying build/lib/jupyter_releaser/actions/__init__.py -> build/bdist.macosx-10.9-x86_64/wheel/jupyter_releaser/actions
copying build/lib/jupyter_releaser/actions/draft_release.py -> build/bdist.macosx-10.9-x86_64/wheel/jupyter_releaser/actions
copying build/lib/jupyter_releaser/actions/generate-changelog.py -> build/bdist.macosx-10.9-x86_64/wheel/jupyter_releaser/actions
copying build/lib/jupyter_releaser/actions/common.py -> build/bdist.macosx-10.9-x86_64/wheel/jupyter_releaser/actions
copying build/lib/jupyter_releaser/actions/publish_release.py -> build/bdist.macosx-10.9-x86_64/wheel/jupyter_releaser/actions
copying build/lib/jupyter_releaser/actions/draft_changelog.py -> build/bdist.macosx-10.9-x86_64/wheel/jupyter_releaser/actions
copying build/lib/jupyter_releaser/python.py -> build/bdist.macosx-10.9-x86_64/wheel/jupyter_releaser
copying build/lib/jupyter_releaser/__main__.py -> build/bdist.macosx-10.9-x86_64/wheel/jupyter_releaser
running install_egg_info
Copying jupyter_releaser.egg-info to build/bdist.macosx-10.9-x86_64/wheel/jupyter_releaser-0.13.2-py3.10.egg-info
running install_scripts
adding license file "LICENSE" (matched pattern "LICEN[CS]E*")
creating build/bdist.macosx-10.9-x86_64/wheel/jupyter_releaser-0.13.2.dist-info/WHEEL
creating '/Users/steve.silvester/workspace/jupyter_releaser/dist/tmp62e85uay/jupyter_releaser-0.13.2-py3-none-any.whl' and adding 'build/bdist.macosx-10.9-x86_64/wheel' to it
adding 'jupyter_releaser/__init__.py'
adding 'jupyter_releaser/__main__.py'
adding 'jupyter_releaser/changelog.py'
adding 'jupyter_releaser/cli.py'
adding 'jupyter_releaser/lib.py'
adding 'jupyter_releaser/npm.py'
adding 'jupyter_releaser/python.py'
adding 'jupyter_releaser/tee.py'
adding 'jupyter_releaser/util.py'
adding 'jupyter_releaser/actions/__init__.py'
adding 'jupyter_releaser/actions/check_links.py'
adding 'jupyter_releaser/actions/common.py'
adding 'jupyter_releaser/actions/draft_changelog.py'
adding 'jupyter_releaser/actions/draft_release.py'
adding 'jupyter_releaser/actions/generate-changelog.py'
adding 'jupyter_releaser/actions/publish_release.py'
adding 'jupyter_releaser/tests/__init__.py'
adding 'jupyter_releaser/tests/conftest.py'
adding 'jupyter_releaser/tests/test_cli.py'
adding 'jupyter_releaser/tests/test_functions.py'
adding 'jupyter_releaser/tests/util.py'
adding 'jupyter_releaser-0.13.2.dist-info/LICENSE'
adding 'jupyter_releaser-0.13.2.dist-info/METADATA'
adding 'jupyter_releaser-0.13.2.dist-info/WHEEL'
adding 'jupyter_releaser-0.13.2.dist-info/entry_points.txt'
adding 'jupyter_releaser-0.13.2.dist-info/top_level.txt'
adding 'jupyter_releaser-0.13.2.dist-info/RECORD'
removing build/bdist.macosx-10.9-x86_64/wheel
Successfully built jupyter_releaser-0.13.2-py3-none-any.whl

[blink1073]

cf jupyter-server/jupyter_releaser#270

[abravalheri]

Hi @blink1073 thank you very much for reporting this.
This seems to be the same issue as reported in #3196.

I think I found the problem, I am currently having some problems to write a minimal test, but I hope to get it out soon.

I will also test wit jupyter server.

[blink1073]

Ah yes, they do seem to be the same error.

[blink1073]

cf jupyter-server/jupyter_server#757 as well.