이 페이지에서는 Windows 호환 규칙 작성, 포팅 가능한 규칙 작성 시 발생하는 일반적인 문제, 몇 가지 솔루션을 중점적으로 설명합니다.
경로
문제:
길이 제한: 최대 경로 길이는 259자(영문 기준)입니다.
Windows는 더 긴 경로 (최대 32,767자)도 지원하지만 많은 프로그램이 하한으로 빌드됩니다.
작업에서 실행하는 프로그램에 관해 알고 있어야 합니다.
작업 디렉터리: 또한 영문 기준 259자로 제한됩니다.
프로세스는 259자가 넘는 디렉터리로
cd
할 수 없습니다.대소문자 구분: Windows 경로는 대소문자를 구분하지 않고, Unix 경로는 대소문자를 구분합니다.
작업의 명령줄을 만들 때 이 점에 유의하세요.
경로 구분자: 백슬래시 (
\`), not forward slash (
/`)Bazel은
/
구분자를 사용하여 Unix 스타일의 경로를 저장합니다. 일부 Windows 프로그램은 Unix 스타일 경로를 지원하지만 다른 프로그램은 지원하지 않습니다. cmd.exe의 내장 명령 중 일부는 지원하지만 그렇지 않은 명령도 있습니다.작업의 명령줄과 환경 변수를 만들 때는 항상
\` separators on Windows: replace
/with
` 를 사용하는 것이 가장 좋습니다.절대 경로: 슬래시 (
/
)로 시작하지 않습니다.Windows의 절대 경로는
C:\foo\bar.txt
과 같은 드라이브 문자로 시작합니다. 하나의 파일 시스템 루트는 없습니다.규칙이 절대 경로인지 확인하는 경우 이러한 점에 유의하세요. 절대 경로는 이동이 불가능한 경우가 많으므로 피해야 합니다.
해결 방법:
경로를 짧게 유지합니다.
긴 디렉터리 이름, 깊이 중첩된 디렉터리 구조, 긴 파일 이름, 긴 작업공간 이름, 긴 대상 이름은 사용하지 마세요.
이 모든 항목이 작업 입력 파일의 경로 구성요소가 될 수 있으며 경로 길이 제한을 소진할 수 있습니다.
짧은 출력 루트를 사용합니다.
--output_user_root=<path>
플래그를 사용하여 Bazel 출력의 짧은 경로를 지정합니다. Bazel 출력 (예:D:\`), and adding this line to your
.bazelrc` 파일) 전용 드라이브 (또는 가상 드라이브)를 두는 것이 좋습니다.build --output_user_root=D:/
사용하여
build --output_user_root=C:/_bzl
연결을 사용합니다.
분기점은 대략적으로[1] 디렉터리 심볼릭 링크입니다. 정션은 쉽게 만들 수 있으며 긴 경로가 있는 동일한 컴퓨터의 디렉터리를 가리킬 수 있습니다. 빌드 작업이 경로는 짧지만 타겟이 긴 정션을 만들면 짧은 경로 제한이 있는 도구는 정션된 디렉터리의 파일에 액세스할 수 있습니다.
.bat
파일 또는 cmd.exe에서 다음과 같이 정션을 만들 수 있습니다.mklink /J c:\path\to\junction c:\path\to\very\long\target\path
[1]: 엄밀히 말하면 연결은 심볼릭 링크가 아닙니다. 하지만 빌드 작업을 위해서는 정션을 디렉터리 심볼릭 링크로 간주할 수 있습니다.
actions / envvars의 경로에서
/
을 `` 로 바꿉니다.작업의 명령줄 또는 환경 변수를 만들 때 경로를 Windows 스타일로 만듭니다. 예:
def as_path(p, is_windows): if is_windows: return p.replace("/", "\\") else: return p
환경 변수
문제:
대소문자 구분: Windows 환경 변수 이름은 대소문자를 구분하지 않습니다.
예를 들어 Java에서
System.getenv("SystemRoot")
와System.getenv("SYSTEMROOT")
는 동일한 결과를 생성합니다. (다른 언어에도 적용됩니다.)휴식: 작업은 가능한 한 적은 수의 맞춤 환경 변수를 사용해야 합니다.
환경 변수는 작업 캐시 키의 일부입니다. 작업이 자주 변경되는 환경 변수를 사용하거나 사용자에게 맞춤설정되는 환경 변수를 사용하면 규칙의 캐시 가능성이 낮아집니다.
해결 방법:
대문자 환경 변수 이름만 사용하세요.
Windows, macOS, Linux에서 작동합니다.
작업 환경 최소화.
ctx.actions.run
를 사용할 때는 환경을ctx.configuration.default_shell_env
로 설정합니다. 작업에 더 많은 환경 변수가 필요하면 모두 사전에 넣고 작업에 전달합니다. 예:load("@bazel_skylib//lib:dicts.bzl", "dicts") def _make_env(ctx, output_file, is_windows): out_path = output_file.path if is_windows: out_path = out_path.replace("/", "\\") return dicts.add(ctx.configuration.default_shell_env, {"MY_OUTPUT": out_path})
작업
문제:
실행 가능한 출력: 모든 실행 파일에는 실행 확장자가 있어야 합니다.
가장 일반적인 확장자는
.exe
(바이너리 파일) 및.bat
(일괄 스크립트)입니다.셸 스크립트 (
.sh
)는 Windows에서 실행할 수 없으며ctx.actions.run
의executable
로 지정할 수 없습니다. 파일에 포함될 수 있는+x
권한도 없으므로 Linux에서와 같이 임의의 파일을 실행할 수 없습니다.Bash 명령어: 이동성을 위해 작업에서 Bash 명령어를 직접 실행하지 않습니다.
Bash는 Unix와 유사한 시스템에서 널리 사용되고 있지만 Windows에서는 사용할 수 없는 경우가 많습니다. Bazel 자체는 Bash (MSYS2)에 대한 의존도가 점점 더 낮아지므로 향후 사용자가 Bazel과 함께 MSYS2를 설치할 가능성이 낮아집니다. Windows에서 규칙을 더 쉽게 사용하려면 작업에서 Bash 명령어를 실행하지 마세요.
줄 끝: Windows는 CRLF (
\r\n
)를 사용하고 Unix와 유사한 시스템은 LF (\n
)를 사용합니다.텍스트 파일을 비교할 때는 이 점에 유의하세요. Git 설정에 유의합니다. 특히 결제하거나 커밋할 때 줄 끝부분에 유의하세요. Git의
core.autocrlf
설정을 참고하세요.
해결 방법:
Bash가 없는 목적의 규칙을 사용합니다.
native.genrule()
는 Bash 명령어를 위한 래퍼이며 파일 복사 또는 텍스트 파일 쓰기와 같은 간단한 문제를 해결하는 데 자주 사용됩니다. Bash에 의존하거나 쓸데없이 시간을 낭비하지 않아도 됩니다. bazel-skylib에 필요에 맞게 제작된 규칙이 있는지 확인하세요. 그 중 어떤 것도 Windows에서 빌드/테스트될 때 Bash에 의존하지 않습니다.빌드 규칙 예:
write_file()
(소스, 문서): 원하는 줄 끝 (auto
,unix
또는windows
)으로 텍스트 파일을 작성하고 원하는 경우 실행 파일로 만듭니다 (스크립트인 경우).run_binary()
(소스, 문서): 빌드 작업으로 지정된 입력 및 예상 출력을 사용하여 바이너리 (또는*_binary
규칙)를 실행합니다(ctx.actions.run
의 빌드 규칙 래퍼).native_binary()
(소스, 문서): 네이티브 바이너리를*_binary
규칙으로 래핑합니다.bazel run
하거나run_binary()
의tool
속성 또는native.genrule()
의tools
속성에 사용할 수 있습니다.
테스트 규칙 예:
Windows에서는 사소한 작업에
.bat
스크립트를 사용해 보세요..sh
스크립트 대신.bat
스크립트를 사용하여 사소한 작업을 해결할 수 있습니다.예를 들어 아무 작업도 하지 않거나 메시지를 출력하거나 수정된 오류 코드로 종료되는 스크립트가 필요한 경우에는 간단한
.bat
파일로 충분합니다. 규칙이DefaultInfo()
공급자를 반환하면executable
필드가 Windows에서 해당.bat
파일을 참조할 수 있습니다.macOS와 Linux에서는 파일 확장자가 중요하지 않으므로 셸 스크립트의 경우에도 항상
.bat
를 확장자로 사용할 수 있습니다.빈
.bat
파일은 실행할 수 없습니다. 빈 스크립트가 필요한 경우 한 칸 띄우세요.Bash를 원칙적으로 사용하세요.
Starlark 빌드 및 테스트 규칙에서
ctx.actions.run_shell
를 사용하여 Bash 스크립트와 Bash 명령어를 작업으로 실행합니다.Starlark 매크로에서 Bash 스크립트와 명령어를
native.sh_binary()
또는native.genrule()
에 래핑합니다. Bazel은 Bash를 사용할 수 있는지 확인하고 Bash를 통해 스크립트나 명령어를 실행합니다.Starlark 저장소 규칙에서 Bash를 완전히 피해 보세요. Bazel은 현재 저장소 규칙에서 원칙적인 방식으로 Bash 명령어를 실행할 방법을 제공하지 않습니다.
파일 삭제
문제:
열린 상태에서는 파일을 삭제할 수 없습니다.
열려 있는 파일은 기본적으로 삭제할 수 없으며 시도하면 '액세스 거부' 오류가 발생합니다. 파일을 삭제할 수 없다면 실행 중인 프로세스에서 파일을 계속 열어 둔 것일 수 있습니다.
실행 중인 프로세스의 작업 디렉터리는 삭제할 수 없습니다.
프로세스에는 작업 디렉터리에 대한 열린 핸들이 있으며 프로세스가 종료될 때까지 디렉터리를 삭제할 수 없습니다.
해결 방법:
코드에서 파일을 빠르게 닫습니다.
Java에서는
try-with-resources
를 사용합니다. Python에서는with open(...) as f:
을 사용합니다. 원칙적으로는 핸들을 가능한 한 빨리 닫습니다.