Trabalhando com o registro NuGet

Você pode configurar a interface de linha de comando (CLI) dotnet para publicar pacotes NuGet em GitHub Packages e usar pacotes armazenados em GitHub Packages como dependências em um projeto .NET.

Quem pode usar esse recurso?

O Enterprise Managed Users pode publicar no namespace de uma organização. Esses usuários não podem publicar pacotes no namespace da conta porque não há alocação de armazenamento pessoal. Para saber mais sobre o Enterprise Managed Users, confira Sobre os Enterprise Managed Users.

Neste artigo

URL do registro do NuGet

Se você acessar GitHub em GitHub.com, publicará pacotes em https://nuget.pkg.github.com. Os exemplos deste artigo usam essa URL.

Se você acessar GitHub em outro domínio, como no domínio octocorp.ghe.com, substitua "https://nuget.pkg.github.com" por https://nuget.SUBDOMAIN.ghe.com, onde SUBDOMAIN é o subdomínio exclusivo da sua empresa.

Autenticar-se no GitHub Packages

Observação

O GitHub Packages dá suporte apenas à autenticação que usa um personal access token (classic). Para saber mais, confira Gerenciar seus tokens de acesso pessoal.

Você precisa de um token de acesso para publicar, instalar e excluir pacotes privados, públicos e internos.

Você pode usar um personal access token (classic) para se autenticar no GitHub Packages ou na API do GitHub. Ao criar um personal access token (classic), você pode atribuir diferentes escopos de token, dependendo da sua necessidade. Para obter mais informações sobre escopos relacionados a pacotes para personal access token (classic), confira Sobre permissões para o GitHub Packages.

Para efetuar a autenticação em um registro do GitHub Packages dentro de um fluxo de trabalho de GitHub Actions, você pode utilizar:

  • GITHUB_TOKEN para publicar pacotes associados ao repositório do fluxo de trabalho.
  • Um personal access token (classic) com pelo menos escopo read:packages para instalar pacotes associados a outros repositórios privados (GITHUB_TOKEN pode ser usado se o repositório receber acesso de leitura ao pacote. Confira, Configurando o controle de acesso e visibilidade de um pacote).

Como se autenticar em um fluxo de trabalho de GitHub Actions

Esse registro dá suporte a permissões granulares. Para registros que dão suporte a permissões granulares, se seu fluxo de trabalho GitHub Actions estiver usando um personal access token para autenticar em um registro, será altamente recomendável que você atualize seu fluxo de trabalho de modo que ele use o GITHUB_TOKEN. Para obter diretrizes sobre como atualizar seus fluxos de trabalho que são autenticados em um registro com um personal access token, confira Publicar e instalar um pacote no GitHub Actions.

Observação

A capacidade dos fluxos de trabalho do GitHub Actions de excluir e restaurar pacotes usando a API REST está em versão prévia pública e está sujeita a alterações.

Você poderá usar um GITHUB_TOKEN em um fluxo de trabalho do GitHub Actions para excluir ou restaurar pacotes usando a API REST, se o token tiver permissão de admin ao pacote. Repositórios que publicam pacotes usando um fluxo de trabalho e repositórios conectados explicitamente a pacotes recebem permissão admin para pacotes no repositório automaticamente.

Para obter mais informações sobre GITHUB_TOKEN, confira Usar GITHUB_TOKEN para autenticação em fluxos de trabalho. Para obter mais informações sobre as melhores práticas ao usar um registro em ações, confira Referência de uso seguro.

Use o seguinte comando para autenticar o GitHub Packages em um fluxo de trabalho do GitHub Actions usando o GITHUB_TOKEN em vez de codificar um personal access token em um arquivo nuget.config no repositório:

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"

Substitua NAMESPACE pelo nome da conta pessoal ou organização a qual seus pacotes têm escopo definido.

Substitua USERNAME pelo nome de usuário a ser usado ao se conectar a uma fonte autenticada.

Também é possível optar por conceder permissões de acesso a pacotes de maneira independente para GitHub Codespaces e GitHub Actions. Para saber mais, confira Configurando o controle de acesso e visibilidade de um pacote e Configurando o controle de acesso e visibilidade de um pacote.

Autenticar com um personal access token

Observação

O GitHub Packages dá suporte apenas à autenticação que usa um personal access token (classic). Para saber mais, confira Gerenciar seus tokens de acesso pessoal.

Você precisa de um token de acesso para publicar, instalar e excluir pacotes privados, públicos e internos.

Você pode usar um personal access token (classic) para se autenticar no GitHub Packages ou na API do GitHub. Ao criar um personal access token (classic), você pode atribuir diferentes escopos de token, dependendo da sua necessidade. Para obter mais informações sobre escopos relacionados a pacotes para personal access token (classic), confira Sobre permissões para o GitHub Packages.

Para efetuar a autenticação em um registro do GitHub Packages dentro de um fluxo de trabalho de GitHub Actions, você pode utilizar:

  • GITHUB_TOKEN para publicar pacotes associados ao repositório do fluxo de trabalho.
  • Um personal access token (classic) com pelo menos escopo read:packages para instalar pacotes associados a outros repositórios privados (GITHUB_TOKEN pode ser usado se o repositório receber acesso de leitura ao pacote. Confira, Configurando o controle de acesso e visibilidade de um pacote).

Você precisa usar um personal access token (classic) com os escopos apropriados para publicar e instalar pacotes no GitHub Packages. Para saber mais, confira Introdução ao GitHub Packages.

Para autenticar no GitHub Packages com a interface de linha de comando (CLI) dotnet, crie um arquivo nuget.config em seu diretório de projeto especificando GitHub Packages como uma fonte sob packageSources para o cliente da CLI dotnet.

Você deve substituir: * USERNAME com o nome de sua conta de usuário em GitHub. * TOKEN com seu personal access token (classic).

  •           `NAMESPACE` pelo nome da conta pessoal ou organização a qual seus pacotes têm escopo definido.

<?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>

Publicando um pacote

Observação

O arquivo nupkg para uma versão do pacote NuGet deve ter o tamanho menor que 2,147 GB.

Você pode publicar um pacote no GitHub Packages autenticando-se com um arquivo nuget.config, usando a opção de linha de comando do --api-key com seu GitHub personal access token (classic) ou usando um comando que possa ser executado diretamente da linha de comando usando a interface de linha de comando (CLI) do dotnet.

Substitua OWNER pelo seu nome de usuário ou nome da empresa e YOUR_GITHUB_PAT pelo seu 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"

O registro do NuGet armazena pacotes em sua organização ou conta pessoal e permite que você associe pacotes a um repositório. Você pode escolher se deve herdar permissões de um repositório ou definir permissões granulares, independentemente de um repositório.

Ao publicar um pacote pela primeira vez a visibilidade-padrão será privada. Para mudar a visibilidade ou definir permissões de acesso, confira Configurando o controle de acesso e visibilidade de um pacote. Para obter mais informações sobre como vincular um pacote publicado a um repositório, consulte Conectar um repositório a um pacote.

Se você especificar um RepositoryURL no arquivo .csproj do project, o pacote publicado será conectado automaticamente ao repositório especificado. Para obter mais informações, consulte Trabalhando com o registro NuGet. Para obter informações sobre como vincular um pacote já publicado a um repositório, consulte Conectar um repositório a um pacote.

Como publicar um pacote usando um GitHub personal access token como sua chave de API

Se você ainda não tiver um personal access token para usar para sua conta em GitHub, consulte Gerenciar seus tokens de acesso pessoal.

  1. Crie um novo project. Substitua PROJECT_NAME pelo nome que você gostaria de dar ao project.

    dotnet new console --name PROJECT_NAME

  2. Empacotar o projeto.

    dotnet pack --configuration Release

  3. Publique o pacote usando seu personal access token como chave de API. Substitua PROJECT_NAME pelo nome do projeto, 1.0.0 pelo número de versão do pacote e YOUR_GITHUB_PAT pelo personal access token.

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

Após publicar um pacote, você poderá visualizá-lo no GitHub. Para saber mais, confira Visualizar pacotes.

Como publicar um pacote usando um arquivo nuget.config

Ao publicar, se você estiver vinculando seu pacote a um repositório, o OWNER do repositório especificado em seu arquivo .csproj deverá corresponder ao NAMESPACE que você usa em seu arquivo de autenticação nuget.config. Especifique ou incremente o número de versão no arquivo .csproj e use o comando dotnet pack para criar um arquivo .nuspec para essa versão. Para obter mais informações sobre como criar seu pacote, confira Criar e publicar um pacote na documentação da Microsoft.

Observação

Se você publicar um pacote vinculado a um repositório, o pacote herdará automaticamente as permissões de acesso do repositório vinculado e os fluxos de trabalho do GitHub Actions no repositório vinculado obterão automaticamente acesso ao pacote, a menos que a sua organização tenha desabilitado a herança automática das permissões de acesso. Para saber mais, confira Configurando o controle de acesso e visibilidade de um pacote.

  1. Autenticar para GitHub Packages. Para saber mais, confira Autenticação no GitHub Packages.

  2. Crie um novo project. Substitua PROJECT_NAME pelo nome que você gostaria de dar ao project.

    dotnet new console --name PROJECT_NAME

  3. Adicione as informações específicas do seu projeto ao arquivo do seu projeto, que termina em .csproj. Certifique-se de substituir:

    •      `1.0.0` pelo número de versão do pacote.

    •           `OWNER` pelo nome da conta pessoal ou organização que é proprietário do repositório ao qual você deseja vincular seu pacote.

    •      `REPOSITORY` com o nome do repositório ao qual você deseja conectar seu pacote.

    <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. Empacote o projeto.

    dotnet pack --configuration Release

  5. Publique o pacote usando a key que você especificou no arquivo nuget.config. Substitua PROJECT_NAME pelo nome do project e substitua 1.0.0 pelo número de versão do pacote.

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

Após publicar um pacote, você poderá visualizá-lo no GitHub. Para saber mais, confira Visualizar pacotes.

Publicar vários pacotes no mesmo repositório

Para conectar vários pacotes ao mesmo repositório, use a mesma URL do repositório GitHub nos campos RepositoryURL em todos os arquivos .csproj. O GitHub corresponde ao repositório baseado nesse campo.

O seguinte exemplo publica os projetos MY_APP e MY_OTHER_APP no mesmo repositório:

<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>

Instalando um pacote

O uso de pacotes de GitHub em seu projeto é semelhante ao uso de pacotes de nuget.org. Adicione as dependências do pacote ao arquivo .csproj, especificando o nome do pacote e a versão. Para obter mais informações sobre como usar um arquivo .csproj em seu projeto, consulte Trabalhando com os pacotes NuGet na documentação da Microsoft.

  1. Autenticar para GitHub Packages. Para saber mais, confira Autenticação no GitHub Packages.

  2. Para usar um pacote, adicione ItemGroup e configure o campo PackageReference no arquivo .csproj project. Substitua o valor PACKAGE_NAME em Include="PACKAGE_NAME" por sua dependência de pacote, e o valor X.X.X em Version="X.X.X" pela versão do pacote que deseja usar:

    <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. Instale os pacotes com o comando restore.

    dotnet restore

Solução de problemas

Se você estiver usando um GITHUB_TOKEN para autenticar em um registro GitHub Packages dentro de um fluxo de trabalho GitHub Actions, o token não poderá acessar pacotes baseados em um repositório privado diferente daquele onde o fluxo de trabalho está sendo executado. Para acessar pacotes associados a outros repositórios, em vez disso, gere um personal access token (classic) com o escopo read:packages e passe esse token como um segredo.

Erros intermitentes 403 ao restaurar pacotes públicos

Se você estiver usando GitHub Packages juntamente com nuget.org e enfrentando erros intermitentes 403 Proibido ao restaurar pacotes públicos padrão (como Microsoft.Extensions.*), isso pode ocorrer porque o NuGet consulta todas as fontes de pacote configuradas para cada pacote. Se a autenticação de GitHub Packages falhar temporariamente, ela poderá bloquear toda a restauração, mesmo para pacotes que não existem em GitHub Packages.

Para evitar isso, use o Mapeamento de Origem do Pacote NuGet para rotear pacotes para fontes específicas.

Substituir:

  •           `NAMESPACE` com o nome da conta pessoal ou organização que tem o feed NuGet do GitHub Packages.

  •           `PACKAGE-ID-PREFIX` com o prefixo de ID do pacote NuGet que você usa para pacotes hospedados em GitHub Packages. Se você usar vários prefixos, adicione mais entradas `<package>` para cada prefixo.

<configuration>
    <packageSources>
        <add key="nuget.org" value="https://api.nuget.org/v3/index.json" />
        <add key="github" value="https://nuget.pkg.github.com/NAMESPACE/index.json" />
    </packageSources>
    <packageSourceMapping>
        <packageSource key="nuget.org">
            <package pattern="*" />
        </packageSource>
        <packageSource key="github">
            <package pattern="PACKAGE-ID-PREFIX.*" />
        </packageSource>
    </packageSourceMapping>
</configuration>

O NuGet usa o padrão de correspondência mais específico, de modo que os pacotes que correspondem a PACKAGE-ID-PREFIX.* são buscados somente de GitHub Packages, enquanto todos os outros pacotes são buscados de nuget.org. Isso também ajuda a evitar ataques de confusão de dependência, garantindo que seus pacotes privados só possam vir do feed do seu GitHub Packages.

Leitura adicional

  •         [AUTOTITLE](/packages/learn-github-packages/deleting-and-restoring-a-package)