MSBuild를 이용해 프로젝트 배포 후 결과물을 zip 파일로 압축하는 방법

비주얼 스튜디오에서 "Publish"를 메뉴를 선택해 배포했을 때 결과물을 단일 .zip 파일로 생성하고 싶을 때가 있습니다. 물론, 별도의 명령행으로 빌드 스크립트를 만드는 것도 가능하지만,

MSBuild - x86/x64, .NET 2/4, debug/release 빌드에 대한 배치 처리
; https://www.sysnet.pe.kr/2/0/1017

PowerShell로 Visual Studio 빌드 스크립트 작성
; https://www.sysnet.pe.kr/2/0/1687

때로는 그냥 비주얼 스튜디오에서 모든 걸 해결하고 싶을 때가 있기 마련입니다. ^^

일례로, ASP.NET Core 프로젝트를 만들었는데 Publish 메뉴 실행 시 결과물을 .zip 파일로 생성하고 싶다면 어떻게 해야 할까요? 닷넷 코어 웹 프로젝트를 "폴더"를 대상으로 배포하면 기본적으로 다음의 글에 설명했던 것처럼,

ASP.NET Core Web Application을 IIS에서 호스팅하는 방법
; https://www.sysnet.pe.kr/2/0/11120

bin\Release\PublishOutput 폴더에 배포됩니다. 그리고 배포되자마자 해당 폴더를 .zip 파일로 만들기 위해 프로젝트 속성에서 "Build Events"를 이용할 수도 있지만 msbuild의 고유 기능을 이용하는 것도 가능합니다. 즉, .csproj 프로젝트 파일에 MSBuild Task를 정의하는 것이 가능한데요, 이에 대해서는 지난 글에서 이미 대략 설명을 했습니다.

MSBuild - 빌드 전/후, 배포 전/후 실행하고 싶은 Task 정의
; https://www.sysnet.pe.kr/2/0/11507

이 글에서 우리가 원하는 압축 작업은 배포(Publish) 이후니까 다음과 같이 Target을 시작하면 됩니다.

<Project Sdk="Microsoft.NET.Sdk.Web">

    <PropertyGroup>
        <TargetFramework>net461</TargetFramework>
    </PropertyGroup>

    <ItemGroup>
        <PackageReference Include="Microsoft.AspNetCore" Version="2.0.0" />
        <PackageReference Include="Microsoft.AspNetCore.Mvc" Version="2.0.0" />
        <PackageReference Include="Microsoft.AspNetCore.Mvc.Razor.ViewCompilation" Version="2.0.0" PrivateAssets="All" />
        <PackageReference Include="Microsoft.AspNetCore.StaticFiles" Version="2.0.0" />
        <PackageReference Include="Microsoft.VisualStudio.Web.BrowserLink" Version="2.0.0" />
    </ItemGroup>

    <ItemGroup>
        <DotNetCliToolReference Include="Microsoft.VisualStudio.Web.CodeGeneration.Tools" Version="2.0.0" />
    </ItemGroup>

    <Target Name="MyAfterPublish" AfterTargets="Publish">
        <!-- task to zip -->
    </Target>

</Project>

이제 저 Target 안에 배포 폴더를 압축하는 Task를 넣으면 되는데요. 여기서 우선 알아야 할 것은 배포 폴더의 경로입니다. 경로에 대한 하드 코딩을 할 수도 있지만 msbuild 내부에서 사용되는 각종 매크로 변수들을 이용하면 좀 더 유연한 스크립트 작성을 할 수 있습니다. Target 작업들에서 어떤 변수들이 사용되고 있는지 알아내는 가장 쉬운 방법은 비주얼 스튜디오의 "TOOLS" / "Options" 메뉴에서 "Projects and Solutions" / "Build and Run" 범주의 "MSBuild project build output verbosity" 항목을 "Detailed" 또는 "Diagnostic" 정도로 설정하고 빌드/배포를 해보는 것입니다. 그럼, Output 창에 꽤 많은 내용들이 출력되는데 그중에서 배포 파일들이 출력되는 경로를 담은 변수를 센스 있게 ^^ 찾아내면 됩니다. 또는 아래의 문서들이 도움이 될 수 있습니다.

Common MSBuild Project Properties
; https://docs.microsoft.com/en-us/previous-versions/visualstudio/visual-studio-2015/msbuild/common-msbuild-project-properties

Team Build에 사용되는 각종 Property 값
; https://www.sysnet.pe.kr/2/0/508

(또는 비주얼 스튜디오 프로젝트 속성 창의 "Build Events" 정의 창에서 확인하는 "Macro" 값들)

다음은 제가 찾아낸 값입니다.

<Message Importance="high" Text="PublishPath: ================= $(ProjectDir)$(PublishUrl)" /> 

그다음, 결정할 것이 .zip 파일에 대한 경로입니다. 우선 zip 파일이 생성될 디렉터리 경로는 다음과 같이 정하고,

<Message Importance="high" Text="ZipFolder: ================= $(ProjectDir)bin\" /> 

zip 파일명은 TargetName을 따르면 됩니다.

<Message Importance="high" Text="ZipFileName: ================= $(TargetName).zip" /> 

마지막으로 위의 인자들을 가지고 압축 Task를 작성하면 됩니다.

---

아쉽게도 압축 파일을 만드는 Task는 msbuild에서 기본으로는 제공하고 있지 않습니다. 따라서, 사용자 정의 task를 만들거나 이미 누군가 만들어 놓은 task를 이용하면 됩니다. 아래는 이럴 때 자주 언급되는 MSBuildCommunityTasks입니다.

loresoft/msbuildtasks 
; https://github.com/loresoft/msbuildtasks

위의 msi 파일로 설치하면 시스템 전역적으로 제공되는 반면, 프로젝트 레벨에서만 MSBuildCommunityTasks를 사용하고 싶다면 NuGet 설치를 하면 됩니다.

Install-Package MSBuildTasks -Version 1.5.0.235 
; https://www.nuget.org/packages/MSBuildTasks

전역/프로젝트 레벨에 따라 적절하게 Import 노드를 구성해 MSBuild.Community.Tasks.Targets을 포함한 후 Zip task를 사용할 수 있습니다.

<Import Project="lib\MSBuildCommunityTasks\MSBuild.Community.Tasks.Targets" />
<Target Name="Zip">
  <CreateItem Include="YourSourceFolder\*.*" >
      <Output ItemName="ZipFiles" TaskParameter="Include"/>
  </CreateItem>
  <Zip ZipFileName="YourZipFile.zip" WorkingDirectory="YourSourceFolder" Files="@(ZipFiles)" />
</Target>

또는, PowerShell을 이용할 수도 있습니다. Exec Task를 이용해 PowerShell에서 .NET 코드를 호출하는 기능을 이용하면,

<Exec Command="powershell.exe -nologo -noprofile -command &quot;&amp; { Add-Type -A 'System.IO.Compression.FileSystem'; [IO.Compression.ZipFile]::CreateFromDirectory('...[path]...', '...[zip file path]...'); }&quot;"/>  

다음과 같이 Target을 작성할 수 있습니다.

<Target Name="MyAfterPublish" AfterTargets="Publish">
    <Message Importance="high" Text="PublishPath ================= $(ProjectDir)$(PublishUrl)" /> 
    <Message Importance="high" Text="ZipFolder ================= $(ProjectDir)bin\" /> 
    <Message Importance="high" Text="ZipFileName ================= $(TargetName).zip" /> 
 
    <Delete Files="$(ProjectDir)bin\$(TargetName).zip" />
    <Exec Command="powershell.exe -nologo -noprofile -command &quot;&amp; { Add-Type -A 'System.IO.Compression.FileSystem'; [IO.Compression.ZipFile]::CreateFromDirectory('$(ProjectDir)$(PublishUrl)', '$(ProjectDir)bin\$(TargetName).zip'); }&quot;"/>  
</Target>

이 외에, MSBuild에서 C# 코드를 직접 호출할 수 있는 기능이 CodeTaskFactory에 의해 제공되므로 위의 PowerShell 대신 사용하는 것도 가능합니다.

Visual Studio 2017 - MSBuild Inline Tasks
; https://docs.microsoft.com/en-us/visualstudio/msbuild/msbuild-inline-tasks

Visual Studio 2015 - MSBuild Inline Tasks
; https://docs.microsoft.com/en-us/previous-versions/visualstudio/visual-studio-2015/msbuild/msbuild-inline-tasks

CodeTaskFactory가 담긴 어셈블리의 파일 명이 환경에 따라 Microsoft.Build.Tasks.v12.0.dll, Microsoft.Build.Tasks.Core.dll와 같이 다르다는 점에 주의해야 합니다.

Visual Studio 2017을 사용한다는 가정으로 Microsoft.Build.Tasks.Core.dll을 사용하면 다음과 같이 압축 스크립트를 Target에 끼워 넣을 수 있습니다.

<Target Name="MyAfterPublish" AfterTargets="Publish">
    <Message Importance="high" Text="PublishPath ================= $(ProjectDir)$(PublishUrl)" /> 
    <Message Importance="high" Text="ZipFolder ================= $(ProjectDir)bin\" /> 
    <Message Importance="high" Text="ZipFileName ================= $(TargetName).zip" /> 
 
    <Delete Files="$(ProjectDir)bin\$(TargetName).zip" />
    <ZipWebAppTask ZipDir="$(ProjectDir)$(PublishUrl)" ZipFilePath="$(ProjectDir)bin\$(TargetName).zip" /> 
</Target>

<UsingTask  
    TaskName="ZipWebAppTask"  
    TaskFactory="CodeTaskFactory"  
    AssemblyFile="$(MSBuildToolsPath)\Microsoft.Build.Tasks.Core.dll" >  

    <ParameterGroup>  
        <ZipFilePath ParameterType="System.String" Required="true" />  
        <ZipDir ParameterType="System.String" Required="true" />  
    </ParameterGroup>  

    <Task>  
        <Reference Include="System" />  
        <Reference Include="System.IO.Compression.FileSystem" />  
        <Using Namespace="System" />  
        <Using Namespace="System.IO" />  
        <Using Namespace="System.IO.Compression" />  
        <Code Type="Fragment" Language="cs">  
<![CDATA[ 
ZipFile.CreateFromDirectory(ZipDir, ZipFilePath);
]]>  
        </Code>  
    </Task>  
</UsingTask>  

(첨부 파일은 이 글의 예제 프로젝트 파일입니다.)

---

[이 글에 대해서 여러분들과 의견을 공유하고 싶습니다. 틀리거나 미흡한 부분 또는 의문 사항이 있으시면 언제든 댓글 남겨주십시오.]

[최초 등록일: 4/23/2018]
[최종 수정일: 7/13/2021]


이 저작물은 크리에이티브 커먼즈 코리아 저작자표시-비영리-변경금지 2.0 대한민국 라이센스에 따라 이용하실 수 있습니다.

by SeongTae Jeong, mailto:techsharer at outlook.com