NuGet 레지스트리 작업

NuGet 패키지를 GitHub Packages에 게시하고 GitHub Packages에 저장된 패키지를 .NET 프로젝트의 종속성으로 사용하도록 dotnet CLI(명령줄 인터페이스)를 구성할 수 있습니다.

누가 이 기능을 사용할 수 있나요?

GitHub Packages는 GitHub Free, GitHub Pro, 조직용 GitHub Free, GitHub Team, GitHub Enterprise Cloud, GitHub Enterprise Server 3.0 이상을 이용해 사용할 수 있습니다.
GitHub Packages는 레거시 리포지토리별 플랜을 사용하는 계정이 소유한 프라이빗 리포지토리에서 사용할 수 없습니다. 또한 레거시 리포지토리별 계획을 사용하는 계정은 세분화된 권한을 지원하는 레지스트리에 액세스할 수 없습니다. 이러한 계정은 리포지토리에서 청구되기 때문입니다. Enterprise Managed Users에는 계정의 네임스페이스 내에 패키지를 게시하기 위한 개별 스토리지 할당이 없지만 조직의 네임스페이스에 게시할 수 있습니다. Enterprise Managed Users에 대한 자세한 내용은 "Enterprise Managed Users 정보"을 참조하세요. 세분화된 권한을 지원하는 레지스트리 목록은 "GitHub 패키지에 대한 사용 권한 정보"을 참조하세요. 자세한 내용은 “GitHub의 플랜”를 참조하세요.

이 문서의 내용

NuGet 레지스트리의 URL

GitHub.com에서 GitHub에 액세스하는 경우 https://nuget.pkg.github.com에 패키지를 게시합니다. 이 문서의 예제에서는 이 URL을 사용합니다.

octocorp.ghe.com과 같은 다른 도메인에서 GitHub에 액세스하는 경우 "https://nuget.pkg.github.com"을 https://nuget.SUBDOMAIN.ghe.com으로 바꾸세요. 여기서 SUBDOMAIN은 엔터프라이즈의 고유 하위 도메인입니다.

GitHub Packages 인증

GitHub Packages은(는) personal access token (classic)을(를) 사용하는 인증만 지원합니다. 자세한 내용은 "개인용 액세스 토큰 관리"을(를) 참조하세요.

프라이빗, 내부, 퍼블릭 패키지를 게시, 설치, 삭제하려면 액세스 토큰이 필요합니다.

GitHub Packages 또는 GitHub API에 인증하는 데 personal access token (classic)을 사용할 수 있습니다. personal access token (classic)을(를) 만들 때 필요에 따라 토큰의 범위를 다르게 할당할 수 있습니다. personal access token (classic)의 패키지 관련 범위에 대한 자세한 내용은 "GitHub 패키지에 대한 사용 권한 정보"을 참조하세요.

GitHub Actions 워크플로 내에서 GitHub Packages 레지스트리에 인증하려면 다음을 사용할 수 있습니다.

  • 워크플로 리포지토리와 연결된 패키지를 게시하려면 GITHUB_TOKEN을 사용합니다.
  • 다른 프라이빗 리포지토리(GITHUB_TOKEN는 액세스할 수 없음)와 연결된 패키지를 설치하기 위해 최소 read:packages 범위의 personal access token (classic).

GitHub Actions 워크플로에서 인증

이 레지스트리는 세분화된 권한을 지원합니다. 세분화된 권한을 지원하는 레지스트리는 GitHub Actions 워크플로가 personal access token을(를) 사용하여 레지스트리에 인증하는 경우, GITHUB_TOKEN로 워크플로를 업데이트하는 것을 권장합니다. personal access token로 레지스트리에 인증하는 워크플로를 업데이트하는 방법에 대한 지침은 "GitHub Actions를 사용하여 패키지 게시 및 설치"을 참조하세요.

참고: GitHub Actions 워크플로에서 REST API를 사용하여 패키지를 삭제하고 복원하는 기능은 현재 공개 미리 보기 버전이며 변경될 수 있습니다.

토큰이 패키지에 대해 admin 권한이 있는 경우, GitHub Actions 워크플로에서 GITHUB_TOKEN로 REST API를 사용하여 패키지를 삭제하거나 복원할 수 있습니다. 워크플로를 사용하여 패키지를 게시하는 리포지토리와 패키지에 명시적으로 연결한 리포지토리에는 리포지토리의 패키지에 대한 admin 권한이 자동으로 부여됩니다.

GITHUB_TOKEN의 자세한 내용은 "자동 토큰 인증"을 참조하세요. 작업에서 레지스트리를 사용하는 모범 사례에 대한 자세한 내용은 "GitHub Actions에 대한 보안 강화"을 참조하세요.

다음 명령을 사용하여 리포지토리의 nuget.config 파일에서 personal access token을(를) 하드코딩하는 대신 GitHub Actions에서 GITHUB_TOKEN을 사용하여 GitHub Packages에 인증합니다.

dotnet nuget add source --username USERNAME --password ${{ secrets.GITHUB_TOKEN }} --store-password-in-clear-text --name github "https://nuget.pkg.github.com/NAMESPACE/index.json"

NAMESPACE를 패키지의 범위로 지정된 조직의 개인 계정 이름으로 바꿉니다.

USERNAME을(를) 인증된 소스에 연결할 때 사용할 사용자 이름으로 바꿉니다.

GitHub Codespaces및 GitHub Actions에 대한 패키지의 액세스 권한을 독립적으로 부여하도록 선택할 수도 있습니다. 자세한 내용은 "패키지의 액세스 제어 및 표시 여부 구성" 및 "패키지의 액세스 제어 및 표시 여부 구성"을 참조하세요.

personal access token을(를) 사용하여 인증

GitHub Packages은(는) personal access token (classic)을(를) 사용하는 인증만 지원합니다. 자세한 내용은 "개인용 액세스 토큰 관리"을(를) 참조하세요.

프라이빗, 내부, 퍼블릭 패키지를 게시, 설치, 삭제하려면 액세스 토큰이 필요합니다.

GitHub Packages 또는 GitHub API에 인증하는 데 personal access token (classic)을 사용할 수 있습니다. personal access token (classic)을(를) 만들 때 필요에 따라 토큰의 범위를 다르게 할당할 수 있습니다. personal access token (classic)의 패키지 관련 범위에 대한 자세한 내용은 "GitHub 패키지에 대한 사용 권한 정보"을 참조하세요.

GitHub Actions 워크플로 내에서 GitHub Packages 레지스트리에 인증하려면 다음을 사용할 수 있습니다.

  • 워크플로 리포지토리와 연결된 패키지를 게시하려면 GITHUB_TOKEN을 사용합니다.
  • 다른 프라이빗 리포지토리(GITHUB_TOKEN는 액세스할 수 없음)와 연결된 패키지를 설치하기 위해 최소 read:packages 범위의 personal access token (classic).

적절한 범위의personal access token (classic)으로 GitHub Packages에서 패키지를 게시하고 설치해야 합니다. 자세한 내용은 "GitHub 패키지 소개"을(를) 참조하세요.

dotnet 명령줄 인터페이스(CLI)로 GitHub Packages에 인증하려면 dotnet CLI 클라이언트에 대한 packageSources에서GitHub Packages를 소스로 지정하여 프로젝트 디렉터리 파일에서 nuget.config 파일을 만듭니다.

아래와 같이 바꿔야 합니다.

  • USERNAME을 GitHub에 있는 개인 계정의 이름으로 바꿉니다.
  • TOKEN을 personal access token (classic)(으)로 바꿉니다.
  • NAMESPACE를 패키지의 범위로 지정된 개인 계정 또는 조직의 이름으로 바꿉니다.
<?xml version="1.0" encoding="utf-8"?>
<configuration>
    <packageSources>
        <clear />
        <add key="github" value="https://nuget.pkg.github.com/NAMESPACE/index.json" />
    </packageSources>
    <packageSourceCredentials>
        <github>
            <add key="Username" value="USERNAME" />
            <add key="ClearTextPassword" value="TOKEN" />
        </github>
    </packageSourceCredentials>
</configuration>

패키지 게시

nuget.config 파일로 인증하거나 GitHub personal access token (classic)(으)로 --api-key 명령줄 옵션을 사용하거나 dotnet 명령줄 인터페이스(CLI)를 사용하여 명령줄에서 직접 실행할 수 있는 명령을 사용하여 GitHub Packages에 패키지를 게시할 수 있습니다.

OWNER을(를) 사용자 이름 또는 회사 이름으로 바꾸고 YOUR_GITHUB_PAT을(를) personal access token(으)로 바꿉니다.

dotnet nuget add source --username OWNER --password YOUR_GITHUB_PAT --store-password-in-clear-text --name github "https://nuget.pkg.github.com/OWNER/index.json"

NuGet 레지스트리는 조직 또는 개인 계정 내에 패키지를 저장하며 패키지를 리포지토리와 연결할 수 있게 합니다. 리포지토리에서 사용 권한을 상속할지 또는 리포지토리와 독립적으로 세분화된 권한을 설정할지 선택할 수 있습니다.

패키지를 처음 게시할 때 기본 표시 여부는 프라이빗입니다. 표시 유형 또는 액세스 권한을 변경하려면 "패키지의 액세스 제어 및 표시 여부 구성"을 참조하세요. 게시된 패키지를 리포지토리와 연결하는 방법에 대한 자세한 내용은 "리포지토리를 패키지에 연결" 항목을 참조하세요.

프로젝트의 .csproj 파일에서 RepositoryURL을 지정하면 게시된 패키지가 지정된 리포지토리에 자동으로 연결됩니다. 자세한 내용은 "NuGet 레지스트리 작업"을(를) 참조하세요. 이미 게시된 패키지를 리포지토리에 연결하는 방법에 대한 자세한 내용은 "리포지토리를 패키지에 연결" 항목을 참조하세요.

GitHub personal access token을(를) 사용하여 패키지를 API 키로 게시

GitHub에서 계정에 사용할 personal access token이(가) 아직 없는 경우, "개인용 액세스 토큰 관리" 항목을 참조하세요.

  1. 새 프로젝트를 만듭니다. PROJECT_NAME을(를) 프로젝트에 사용할 이름으로 바꿉니다.

    dotnet new console --name PROJECT_NAME

  2. 프로젝트를 패키지합니다.

    dotnet pack --configuration Release

  3. personal access token을(를) API 키로 사용하여 패키지를 게시합니다. PROJECT_NAME을 프로젝트 이름으로, 1.0.0을 패키지의 버전 번호로 YOUR_GITHUB_PAT를 personal access token(으)로 각각 바꿉니다.

    dotnet nuget push "bin/Release/PROJECT_NAME.1.0.0.nupkg"  --api-key YOUR_GITHUB_PAT --source "github"

패키지를 게시한 후 GitHub에서 패키지를 볼 수 있습니다. 자세한 내용은 "패키지 보기"을(를) 참조하세요.

nuget.config 파일을 사용하여 패키지 게시

게시할 때 패키지를 리포지토리에 연결하는 경우 .csproj 파일에 지정된 리포지토리의 OWNER가 nuget.config 인증 파일에 사용하는 NAMESPACE와 일치해야 합니다. .csproj 파일에 버전 번호를 지정하거나 증분한 다음 dotnet pack 명령을 사용하여 해당 버전에 맞는 .nuspec 파일을 만듭니다. 패키지를 만드는 방법에 대한 자세한 내용은 Microsoft 설명서의 “패키지 만들기 및 게시”를 참조하세요.

참고: 리포지토리에 연결된 패키지를 게시하는 경우, 패키지는 자동으로 연결된 리포지토리의 액세스 권한을 상속받고, 조직에서 액세스 권한의 자동 상속을 사용하지 않도록 설정하지 않은 한 연결된 리포지토리의 GitHub Actions 워크플로에 패키지에 대한 액세스 권한이 자동으로 부여됩니다. 자세한 내용은 "패키지의 액세스 제어 및 표시 여부 구성"을(를) 참조하세요.

  1. GitHub Packages에 인증합니다. 자세한 내용은 “GitHub Packages에 인증”을 참조하세요.

  2. 새 프로젝트를 만듭니다. PROJECT_NAME을(를) 프로젝트에 사용할 이름으로 바꿉니다.

    dotnet new console --name PROJECT_NAME

  3. 프로젝트의 특정 정보를 프로젝트의 파일에 추가합니다. 이 파일은 _.csproj_로 끝납니다. 다음과 같이 바꿔야 합니다.

    • 1.0.0을 패키지의 버전 번호로 바꿉니다.
    • OWNER를 패키지를 연결할 리포지토리를 소유한 개인 계정 또는 조직의 이름으로 바꿉니다.
    • REPOSITORY를 패키지를 연결할 리포지토리의 이름으로 바꿉니다.
    <Project Sdk="Microsoft.NET.Sdk">

  <PropertyGroup>
    <OutputType>Exe</OutputType>
    <TargetFramework>netcoreapp3.0</TargetFramework>
    <PackageId>PROJECT_NAME</PackageId>
    <Version>1.0.0</Version>
    <Authors>AUTHORS</Authors>
    <Company>COMPANY_NAME</Company>
    <PackageDescription>PACKAGE_DESCRIPTION</PackageDescription>
    <RepositoryUrl>https://github.com/OWNER/REPOSITORY</RepositoryUrl>
  </PropertyGroup>

</Project>

  4. 프로젝트를 패키지합니다.

    dotnet pack --configuration Release

  5. key를 사용해 nuget.config 파일에 지정한 패키지를 게시합니다. PROJECT_NAME을 프로젝트 이름으로 바꾸고 1.0.0을 패키지의 버전 번호로 바꿉니다.

    dotnet nuget push "bin/Release/PROJECT_NAME.1.0.0.nupkg" --source "github"

패키지를 게시한 후 GitHub에서 패키지를 볼 수 있습니다. 자세한 내용은 "패키지 보기"을(를) 참조하세요.

동일한 리포지토리에 여러 패키지 게시

여러 패키지를 동일한 리포지토리에 연결하려면 모든 .csproj 프로젝트 파일의 RepositoryURL 필드에 동일한 GitHub 리포지토리 URL을 사용합니다. GitHub은 해당 필드를 기반으로 리포지토리와 일치시킵니다.

다음 예시에서는 MY_APP 및 MY_OTHER_APP 프로젝트를 동일한 리포지토리에 게시합니다.

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

  <PropertyGroup>
    <OutputType>Exe</OutputType>
    <TargetFramework>netcoreapp3.0</TargetFramework>
    <PackageId>MY_APP</PackageId>
    <Version>1.0.0</Version>
    <Authors>Octocat</Authors>
    <Company>GitHub</Company>
    <PackageDescription>This package adds a singing Octocat!</PackageDescription>
    <RepositoryUrl>https://github.com/my-org/my-repo</RepositoryUrl>
  </PropertyGroup>

</Project>

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

  <PropertyGroup>
    <OutputType>Exe</OutputType>
    <TargetFramework>netcoreapp3.0</TargetFramework>
    <PackageId>MY_OTHER_APP</PackageId>
    <Version>1.0.0</Version>
    <Authors>Octocat</Authors>
    <Company>GitHub</Company>
    <PackageDescription>This package adds a dancing Octocat!</PackageDescription>
    <RepositoryUrl>https://github.com/my-org/my-repo</RepositoryUrl>
  </PropertyGroup>

</Project>

패키지 설치

프로젝트에서 GitHub의 패키지를 사용하는 것은 nuget.org 패키지를 사용하는 것과 비슷합니다. .csproj 파일에 패키지 종속성을 추가하여 패키지 이름과 버전을 지정합니다. 프로젝트에서 .csproj 파일을 사용하는 방법에 한 자세한 내용은 Microsoft 설명서의 “NuGet 패키지 작업”을 참조하세요.

  1. GitHub Packages에 인증합니다. 자세한 내용은 “GitHub Packages에 인증”을 참조하세요.

  2. 패키지를 사용하려면 ItemGroup을 추가하고 .csproj 프로젝트 파일에서 PackageReference 필드를 구성합니다. Include="PACKAGE_NAME"의 PACKAGE_NAME 값을 패키지 종속성으로 바꾸고 Version="X.X.X"의 X.X.X 값을 사용하려는 패키지의 버전으로 바꿉니다.

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

  <PropertyGroup>
    <OutputType>Exe</OutputType>
    <TargetFramework>netcoreapp3.0</TargetFramework>
    <PackageId>My-app</PackageId>
    <Version>1.0.0</Version>
   <Authors>Octocat</Authors>
    <Company>GitHub</Company>
   <PackageDescription>This package adds an Octocat!</PackageDescription>
    <RepositoryUrl>https://github.com/OWNER/REPOSITORY</RepositoryUrl>
  </PropertyGroup>

  <ItemGroup>
    <PackageReference Include="PACKAGE_NAME" Version="X.X.X" />
  </ItemGroup>

</Project>

  3. restore 명령으로 패키지를 설치합니다.

    dotnet restore

문제 해결

GITHUB_TOKEN을 이용해 GitHub Actions 워크플로에서 GitHub Packages 레지스트리를 인증한다면, 토큰은 워크플로를 실행하는 리포지토리가 아닌 다른 리포지토리에 있는 프라이빗 리포지토리 기반 패키지에는 액세스할 수 없습니다. 다른 리포지토리에 연결된 패키지에 액세스하려면 대신 read:packages 범위의 personal access token (classic)을(를) 생성하고 이 토큰을 비밀로서 전달해야 합니다.

추가 참고 자료