파이프라인 캐싱

Bundler를 사용하는 Ruby 프로젝트의 경우, Bundler가 Gems를 찾는 경로를 설정하기 위해 BUNDLE_PATH 환경 변수를 재정의합니다.

예:

variables:
  BUNDLE_PATH: $(Pipeline.Workspace)/.bundle

steps:
- task: Cache@2
  displayName: Bundler caching
  inputs:
    key: 'gems | "$(Agent.OS)" | Gemfile.lock'
    path: $(BUNDLE_PATH)
    restoreKeys: | 
      gems | "$(Agent.OS)"
      gems   

Ccache 는 C/C++에 대한 컴파일러 캐시입니다. 파이프라인에서 Ccache를 사용하려면 Ccache이 설치되어 있는지 확인하고, PATH에 선택적으로 추가하세요. 자세한 내용은 Ccache 실행 모드를 참조하세요. CCACHE_DIR 환경 변수를 $(Pipeline.Workspace) 아래의 경로로 설정하고 이 디렉터리를 캐시합니다.

예:

variables:
  CCACHE_DIR: $(Pipeline.Workspace)/ccache

steps:
- bash: |
    sudo apt-get install ccache -y    
    echo "##vso[task.prependpath]/usr/lib/ccache"
  displayName: Install ccache and update PATH to use linked versions of gcc, cc, etc

- task: Cache@2
  displayName: Ccache caching
  inputs:
    key: 'ccache | "$(Agent.OS)" | $(Build.SourceVersion)'
    path: $(CCACHE_DIR)
    restoreKeys: | 
      ccache | "$(Agent.OS)"

자세한 내용은 Ccache 구성 설정을 참조하세요.

Docker 이미지를 캐싱하면 파이프라인을 실행하는 데 걸리는 시간을 크게 줄일 수 있습니다.

variables:
  repository: 'myDockerImage'
  dockerfilePath: '$(Build.SourcesDirectory)/app/Dockerfile'
  tag: '$(Build.BuildId)'

pool:
  vmImage: 'ubuntu-latest'
steps:
  - task: Cache@2
    displayName: Cache task
    inputs:
      key: 'docker | "$(Agent.OS)" | cache'        ## A unique identifier for the cache
      path: $(Pipeline.Workspace)/docker           ## Path of the folder or file that you want to cache
      cacheHitVar: CACHE_RESTORED                  ## Variable to set to 'true' when the cache is restored
    
  - script: |
      docker load -i $(Pipeline.Workspace)/docker/cache.tar
    displayName: Docker restore
    condition: and(not(canceled()), eq(variables.CACHE_RESTORED, 'true'))

  - task: Docker@2
    displayName: 'Build Docker'
    inputs:
      command: 'build'
      repository: '$(repository)'
      dockerfile: '$(dockerfilePath)'
      tags: |
        '$(tag)'

  - script: |
      mkdir -p $(Pipeline.Workspace)/docker
      docker save -o $(Pipeline.Workspace)/docker/cache.tar $(repository):$(tag)
    displayName: Docker save
    condition: and(not(canceled()), not(failed()), ne(variables.CACHE_RESTORED, 'true'))

• Docker buildx를 사용하는 예제:

  steps:
    - task: Cache@2
      displayName: Cache Docker
      inputs:
        key: 'docker | "$(Agent.OS)" | mydockerimage | ./Dockerfile'
        path: $(Pipeline.Workspace)/docker_image_cache
        restoreKeys: |
          docker | "$(Agent.OS)" | mydockerimage
  
    - script: |
        docker buildx create --name builder --driver docker-container --use
        docker buildx build \
          --cache-from=type=local,src=$(Pipeline.Workspace)/docker_image_cache \
          --cache-to=type=local,dest=$(Pipeline.Workspace)/docker_image_cache,mode=max \
          --file ./Dockerfile \
          --output=type=docker,name=mydockerimage \
          .
      displayName: docker buildx
      env:
        DOCKER_BUILDKIT: 1
  

Golang 프로젝트의 경우 go.mod 파일에서 다운로드할 패키지를 지정할 수 있습니다. GOCACHE 변수가 아직 설정되지 않은 경우 캐시를 다운로드할 위치로 설정합니다.

예:

variables:
  GO_CACHE_DIR: $(Pipeline.Workspace)/.cache/go-build/

steps:
- task: Cache@2
  inputs:
    key: 'go | "$(Agent.OS)" | go.mod'
    restoreKeys: | 
      go | "$(Agent.OS)"
    path: $(GO_CACHE_DIR)
  displayName: Cache GO packages

Gradle의 기본 제공 캐싱 지원을 사용하면 빌드 시간에 큰 영향을 미칠 수 있습니다. 빌드 캐시를 사용하도록 설정하려면 GRADLE_USER_HOME 환경 변수를 $(Pipeline.Workspace) 아래의 경로로 설정하고 --build-cache 사용하여 빌드를 실행하거나 org.gradle.caching=true 파일에 gradle.properties 추가합니다.

예:

variables:
  GRADLE_USER_HOME: $(Pipeline.Workspace)/.gradle

steps:
- task: Cache@2
  inputs:
    key: 'gradle | "$(Agent.OS)" | **/build.gradle.kts' # Swap build.gradle.kts for build.gradle when using Groovy
    restoreKeys: |                                      # The fallback keys if the primary key fails (Optional)
      gradle | "$(Agent.OS)"
      gradle
    path: $(GRADLE_USER_HOME)
  displayName: Configure gradle caching

- task: Gradle@4                            # Build using a Gradle wrapper script
  inputs:
    gradleWrapperFile: 'gradlew'            # Alias: wrapperScript. Gradle wrapper.
    tasks: 'build'                          # Default: build. Gradle tasks.
    options: '--build-cache'                # String. Gradle options.
  displayName: Build

- script: |   
    # stop the Gradle daemon to ensure no files are left open (impacting the save cache operation later)
    ./gradlew --stop    
  displayName: Gradlew stop

Maven은 로컬 리포지토리를 사용하여 다운로드한 종속성 및 빌드된 아티팩트를 저장합니다. 캐싱을 사용하려면 maven.repo.local 옵션을 $(Pipeline.Workspace) 아래 경로로 설정하고 이 폴더를 캐시하십시오.

예:

variables:
  MAVEN_CACHE_FOLDER: $(Pipeline.Workspace)/.m2/repository
  MAVEN_OPTS: '-Dmaven.repo.local=$(MAVEN_CACHE_FOLDER)'

steps:
- task: Cache@2
  inputs:
    key: 'maven | "$(Agent.OS)" | **/pom.xml'
    restoreKeys: |
      maven | "$(Agent.OS)"
      maven
    path: $(MAVEN_CACHE_FOLDER)
  displayName: Cache Maven local repo

- script: mvn install -B -e

Maven 작업을 사용하는 경우, 변수가 덮어쓰여지므로 MAVEN_OPTS 변수를 반드시 함께 전달해야 합니다.

- task: Maven@4
  inputs:
    mavenPomFile: 'pom.xml'
    mavenOptions: '-Xmx3072m $(MAVEN_OPTS)'

PackageReferences을 사용하여 프로젝트 파일 내에서 NuGet 종속성을 직접 관리하고, packages.lock.json 파일이 있는 경우, NUGET_PACKAGES 환경 변수를 $(UserProfile) 아래의 경로로 설정하고 이 디렉터리를 캐시함으로써 캐싱을 활성화할 수 있습니다. 종속성을 잠그는 방법에 대한 자세한 내용은 프로젝트 파일 패키지 참조를 참조하세요.

여러 packages.lock.json사용하려는 경우에도 변경하지 않고 다음 예제를 사용할 수 있습니다. 모든 packages.lock.json 파일의 콘텐츠가 해시되고 파일 중 하나가 변경되면 새 캐시 키가 생성됩니다.

예:

variables:
  NUGET_PACKAGES: $(Pipeline.Workspace)/.nuget/packages

steps:
- task: Cache@2
  inputs:
    key: 'nuget | "$(Agent.OS)" | $(Build.SourcesDirectory)/**/packages.lock.json'
    restoreKeys: |
       nuget | "$(Agent.OS)"
       nuget
    path: $(NUGET_PACKAGES)
  displayName: Cache NuGet packages

이 방법은 프로젝트에서 packages.lock.json 사용하여 패키지 버전을 잠그는 경우에도 .NET Core 프로젝트에 유효합니다. RestorePackagesWithLockFile 파일에서 True을 으로 설정하거나 다음 명령(dotnet restore --use-lock-file)을 사용하여 사용할 수 있습니다.

Node.js 프로젝트에서 캐싱을 사용하도록 설정하는 방법에는 여러 가지가 있지만 npm의 공유 캐시 디렉터리를 캐시하는 것이 좋습니다. 이 디렉터리 npm에서 관리 하 고 모든 다운로드 된 모듈의 캐시 된 버전을 포함 합니다. 설치하는 동안 npm은 공용 npm 레지스트리 또는 프라이빗 레지스트리에 대한 네트워크 호출을 줄이거나 제거할 수 있는 이 디렉터리를 먼저 확인합니다(기본적으로).

npm의 공유 캐시 디렉터리에 대한 기본 경로는 플랫폼마다 다르므로 환경 변수를 재정의하여 npm_config_cache 아래의 경로로 설정하는 것이 좋습니다. 이렇게 하면 컨테이너 및 비컨테이너 작업 모두에서 캐시에 액세스할 수 있습니다.

예:

variables:
  npm_config_cache: $(Pipeline.Workspace)/.npm

steps:
- task: Cache@2
  inputs:
    key: 'npm | "$(Agent.OS)" | package-lock.json'
    restoreKeys: |
       npm | "$(Agent.OS)"
    path: $(npm_config_cache)
  displayName: Cache npm

프로젝트에 package-lock.json 파일이 없는 경우 대신 캐시 키 입력에서 package.json 파일을 참조합니다.

npm과 마찬가지로 Yarn은 설치된 패키지를 캐시하는 여러 가지 방법을 제공합니다. Yarn의 공유 캐시 폴더를 캐시하는 것이 좋습니다. 이 디렉터리가 Yarn에서 관리되며 다운로드한 모든 패키지의 캐시된 버전을 저장합니다. 설치하는 동안 Yarn은 공용 또는 프라이빗 레지스트리에 대한 네트워크 호출을 줄이거나 제거할 수 있는 이 디렉터리를 먼저 확인합니다(기본적으로).

예:

variables:
  YARN_CACHE_FOLDER: $(Pipeline.Workspace)/.yarn

steps:
- task: Cache@2
  inputs:
    key: 'yarn | "$(Agent.OS)" | yarn.lock'
    restoreKeys: |
       yarn | "$(Agent.OS)"
       yarn
    path: $(YARN_CACHE_FOLDER)
  displayName: Cache Yarn packages

- script: yarn --frozen-lockfile

Anaconda 환경을 사용하여 파이프라인 캐싱을 설정합니다.

예시

variables:
  CONDA_CACHE_DIR: /usr/share/miniconda/envs

# Add conda to system path
steps:
- script: echo "##vso[task.prependpath]$CONDA/bin"
  displayName: Add conda to PATH

- bash: |
    sudo chown -R $(whoami):$(id -ng) $(CONDA_CACHE_DIR)
  displayName: Fix CONDA_CACHE_DIR directory permissions

- task: Cache@2
  displayName: Use cached Anaconda environment
  inputs:
    key: 'conda | "$(Agent.OS)" | environment.yml'
    restoreKeys: | 
      python | "$(Agent.OS)"
      python
    path: $(CONDA_CACHE_DIR)
    cacheHitVar: CONDA_CACHE_RESTORED

- script: conda env create --quiet --file environment.yml
  displayName: Create Anaconda environment
  condition: eq(variables.CONDA_CACHE_RESTORED, 'false')

• Windows

  - task: Cache@2
    displayName: Cache Anaconda
    inputs:
      key: 'conda | "$(Agent.OS)" | environment.yml'
      restoreKeys: | 
        python | "$(Agent.OS)"
        python
      path: $(CONDA)/envs
      cacheHitVar: CONDA_CACHE_RESTORED
  
  - script: conda env create --quiet --file environment.yml
    displayName: Create environment
    condition: eq(variables.CONDA_CACHE_RESTORED, 'false')
  

Composer를 사용하는 PHP 프로젝트의 경우 Composer에서 사용하는 COMPOSER_CACHE_DIR를 재정의 합니다.

예:

variables:
  COMPOSER_CACHE_DIR: $(Pipeline.Workspace)/.composer

steps:
- task: Cache@2
  inputs:
    key: 'composer | "$(Agent.OS)" | composer.lock'
    restoreKeys: |
      composer | "$(Agent.OS)"
      composer
    path: $(COMPOSER_CACHE_DIR)
  displayName: Cache composer

- script: composer install