Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ci: Remove distribution options to enable default build v0.5.0 behavior #93

Merged
merged 2 commits into from
Jun 19, 2021

Conversation

matthewfeickert
Copy link
Member

@matthewfeickert matthewfeickert commented Jun 19, 2021

Description

Remove the option --sdist --wheel from

- name: Build a binary wheel and a source tarball
run: |
python -m build --sdist --wheel --outdir dist/ .

to enable the default behavior for build in release v0.5.0 of building a sdist and then building a wheel from the sidst to ensure that the sdist is capable of building a wheel. This was added in pypa/build#304

$ pip list | grep build
build       0.5.0
$ python -m build --help
usage: python -m build [-h] [--version] [--sdist] [--wheel] [--outdir OUTDIR] [--skip-dependency-check] [--no-isolation] [--config-setting CONFIG_SETTING] [srcdir]

    A simple, correct PEP 517 package builder.

    By default, a source distribution (sdist) is built from {srcdir}
    and a binary distribution (wheel) is built from the sdist.
    This is recommended as it will ensure the sdist can be used
    to build wheels.

    Pass -s/--sdist and/or -w/--wheel to build a specific distribution.
    If you do this, the default behavior will be disabled, and all
    artifacts will be built from {srcdir} (even if you combine
    -w/--wheel with -s/--sdist, the wheel will be built from {srcdir}).

positional arguments:
  srcdir                source directory (defaults to current directory)

optional arguments:
  -h, --help            show this help message and exit
  --version, -V         show program's version number and exit
  --sdist, -s           build a source distribution (disables the default behavior)
  --wheel, -w           build a wheel (disables the default behavior)
  --outdir OUTDIR, -o OUTDIR
                        output directory (defaults to {srcdir}/dist)
  --skip-dependency-check, -x
                        do not check that build dependencies are installed
  --no-isolation, -n    do not isolate the build in a virtual environment
  --config-setting CONFIG_SETTING, -C CONFIG_SETTING
                        pass options to the backend.  options which begin with a hyphen must be in the form of "--config-setting=--opt(=value)" or "-C--opt(=value)"

Checklist Before Requesting Reviewer

  • Tests are passing
  • "WIP" removed from the title of the pull request
  • Selected an Assignee for the PR to be responsible for the log summary

Before Merging

For the PR Assignees:

  • Summarize commit messages into a comprehensive review of the PR
* Remove `--sdist --wheel` from the build CLI options to enable default behavior for build v0.5.0+
   - By default, a source distribution (sdist) is built from {srcdir} and a binary distribution (wheel) is built from the sdist. This is recommended as it will ensure the sdist can be used to build wheels.
   - c.f. https://pypa-build.readthedocs.io/en/stable/changelog.html
* Add pip list to workflow to spot check versions installed
* Update to pypa/[email protected]

@matthewfeickert matthewfeickert added the CI Continuous Integration label Jun 19, 2021
@matthewfeickert matthewfeickert self-assigned this Jun 19, 2021
@codecov
Copy link

codecov bot commented Jun 19, 2021

Codecov Report

Merging #93 (03fabcd) into master (d35bb32) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master      #93   +/-   ##
=======================================
  Coverage   60.69%   60.69%           
=======================================
  Files           2        2           
  Lines         201      201           
  Branches       36       36           
=======================================
  Hits          122      122           
  Misses         72       72           
  Partials        7        7           
Flag Coverage Δ
unittests 60.69% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.


Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update d35bb32...03fabcd. Read the comment docs.

@matthewfeickert matthewfeickert merged commit 0f8af18 into master Jun 19, 2021
@matthewfeickert matthewfeickert deleted the ci/change-default-build-behavior branch June 19, 2021 22:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
build CI Continuous Integration
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant