Skip to content

{ACR} az acr build: Exclude .venv directories from build #32241

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
yanzhudd merged 3 commits into from
Oct 28, 2025
Merged

{ACR} az acr build: Exclude .venv directories from build #32241

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a7626c1
skip .venv dir to improve build performance
Oct 21, 2025
7e1de94
retry pr validator
Oct 22, 2025
d99166b
update syntax
Oct 23, 2025
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
25 changes: 18 additions & 7 deletions src/azure-cli/azure/cli/command_modules/acr/_archive_utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,13 +66,21 @@ def _pack_source_code(source_location, tar_file_path, docker_file_path, docker_f
original_docker_file_name = os.path.basename(docker_file_path.replace("\\", os.sep))
ignore_list, ignore_list_size = _load_dockerignore_file(source_location, original_docker_file_name)
common_vcs_ignore_list = {'.git', '.gitignore', '.bzr', 'bzrignore', '.hg', '.hgignore', '.svn'}
# Directories that should be completely excluded (no recursive descent) for performance reasons.
# These typically contain large numbers of files that are not needed for container build context.
build_ignore_dirs = {'.venv'}

def _ignore_check(tarinfo, parent_ignored, parent_matching_rule_index):
# ignore common vcs dir or file
if tarinfo.name in common_vcs_ignore_list:
# Ignore common VCS dirs/files by basename so nested instances are handled.
if os.path.basename(tarinfo.name) in common_vcs_ignore_list:
logger.warning("Excluding '%s' based on default ignore rules", tarinfo.name)
return True, parent_matching_rule_index

# Exclude performance-heavy directories entirely (no traversal) regardless of .dockerignore.
if tarinfo.isdir() and os.path.basename(tarinfo.name) in build_ignore_dirs:
Copy link
Copy Markdown
Member

@northtyphoon northtyphoon Oct 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you check if the code will skip all files under the ignored directories? or will it continue to scan all of them?

Copy link
Copy Markdown
Contributor Author

@SakoPak SakoPak Oct 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added line 214 to exclude only the .venv folder ( in "ignored") from being scanned, since we agreed we are doing a targeted fix to only exclude venv. The code will still scan the child items of .git and .docker_ignore, even though those are in ignored group, according to original comment and code on line 212-213 ( "even the dir is ignored, its child items can still be included, so continue to scan"). This PR change will exclude only .venv from this scan.

logger.warning("Excluding '%s' directory for performance", os.path.basename(tarinfo.name))
return True, parent_matching_rule_index

if ignore_list is None:
# if .dockerignore doesn't exists, inherit from parent
# eg, it will ignore the files under .git folder.
Expand Down Expand Up @@ -100,7 +108,8 @@ def _ignore_check(tarinfo, parent_ignored, parent_matching_rule_index):
arcname="",
parent_ignored=False,
parent_matching_rule_index=ignore_list_size,
ignore_check=_ignore_check)
ignore_check=_ignore_check,
build_ignore_dirs=build_ignore_dirs)

# Add the Dockerfile if it's specified.
# In the case of run, there will be no Dockerfile.
Expand Down Expand Up @@ -182,7 +191,8 @@ def _load_dockerignore_file(source_location, original_docker_file_name):
return ignore_list, len(ignore_list)


def _archive_file_recursively(tar, name, arcname, parent_ignored, parent_matching_rule_index, ignore_check):
def _archive_file_recursively(tar, name, arcname, parent_ignored, parent_matching_rule_index,
ignore_check, build_ignore_dirs):
# create a TarInfo object from the file
tarinfo = tar.gettarinfo(name, arcname)

Expand All @@ -201,12 +211,13 @@ def _archive_file_recursively(tar, name, arcname, parent_ignored, parent_matchin
else:
tar.addfile(tarinfo)

# even the dir is ignored, its child items can still be included, so continue to scan
if tarinfo.isdir():
# Even if a dir is ignored by .dockerignore, its children might still be included (Docker semantics),
# so we continue scanning unless it is in our build_ignore_dirs set (performance skip list).
if tarinfo.isdir() and os.path.basename(tarinfo.name) not in build_ignore_dirs:
for f in os.listdir(name):
_archive_file_recursively(tar, os.path.join(name, f), os.path.join(arcname, f),
parent_ignored=ignored, parent_matching_rule_index=matching_rule_index,
ignore_check=ignore_check)
ignore_check=ignore_check, build_ignore_dirs=build_ignore_dirs)


def check_remote_source_code(source_location):
Expand Down