Skip to content

Do not use VCS to include files in sdist by default #772

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Sep 20, 2025
Merged

Do not use VCS to include files in sdist by default #772

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 4 additions & 8 deletions flit/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,16 +103,15 @@ def add_shared_build_options(parser: argparse.ArgumentParser):
help=("Choose which files to include in the sdist using git or hg. "
"This is a convenient way to include all checked-in files, like "
"tests and doc source files, in your sdist, but requires that git "
"or hg is available on the command line. This is currently the "
"default, but it will change in a future version. "
"or hg is available on the command line."
)
)

vcs_grp.add_argument('--no-use-vcs', action='store_true',
help=("Select the files to include in the sdist without using git or hg. "
"This should include all essential files to install and use your "
"package; see the documentation for precisely what is included. "
"This will become the default in a future version."
"This is the default for Flit version 4 and above."
)
)

Expand Down Expand Up @@ -190,14 +189,11 @@ def gen_setup_py():
return False
return args.setup_py

def sdist_use_vcs():
return not args.no_use_vcs

if args.subcmd == 'build':
from .build import main
try:
main(args.ini_file, formats=set(args.format or []),
gen_setup_py=gen_setup_py(), use_vcs=sdist_use_vcs())
gen_setup_py=gen_setup_py(), use_vcs=args.use_vcs)
except(common.NoDocstringError, common.VCSError, common.NoVersionError) as e:
sys.exit(e.args[0])
elif args.subcmd == 'publish':
Expand All @@ -206,7 +202,7 @@ def sdist_use_vcs():
repository = args.repository or args.deprecated_repository
from .upload import main
main(args.ini_file, repository, args.pypirc, formats=set(args.format or []),
gen_setup_py=gen_setup_py(), use_vcs=sdist_use_vcs())
gen_setup_py=gen_setup_py(), use_vcs=args.use_vcs)

elif args.subcmd == 'install':
from .install import Installer
Expand Down
Loading