Trabajar con el registro de NuGet

Autenticación en GitHub Packages

Necesitas un token de acceso para publicar, instalar y eliminar paquetes privados, internos y públicos.

Puedes utilizar un personal access token (classic) para autenticarte en el GitHub Packages o en la API de GitHub. Cuando creas un personal access token (classic), puedes asignar al token diferentes ámbitos en función de tus necesidades. Para más información sobre los ámbitos relacionados con paquetes para un personal access token (classic), consulta Acerca de los permisos para los Paquetes de GitHub.

Para autenticarte en un registro del GitHub Packages dentro de un flujo de trabajo de GitHub Actions, puedes utilizar:

• GITHUB_TOKEN para publicar los paquetes asociados con el repositorio del flujo de trabajo.
• Un personal access token (classic) con al menos alcance read:packages para instalar los paquetes asociados con otros repositorios privados (GITHUB_TOKEN puede utilizarse si el repositorio tiene acceso de lectura al paquete. Consulta Configurar la visibilidad y el control de accesos de un paquete).

Autenticación en un GitHub Actions flujo de trabajo

Este registro admite permisos granulares. Para los registros que admiten permisos detallados, si en el flujo de trabajo de GitHub Actions se usa un personal access token para autenticarse en un registro, se recomienda encarecidamente actualizar el flujo de trabajo para usar GITHUB_TOKEN. Para obtener orientación sobre la actualización de tus flujos de trabajo que se autentican en un registro con un personal access token, consulta Publicar e instalar un paquete con Acciones de GitHub.

Puede usar un GITHUB_TOKEN en un flujo de trabajo de GitHub Actions para eliminar o restaurar un paquete mediante la API de REST, si el token tiene el permiso admin para el paquete. A los repositorios que publican paquetes mediante un flujo de trabajo y a los repositorios que se han conectado explícitamente a los paquetes se les concede automáticamente el permiso admin para los paquetes del repositorio.

Para obtener más información sobre GITHUB_TOKEN, consulta Uso de GITHUB_TOKEN para la autenticación en flujos de trabajo. Para obtener más información sobre los procedimientos recomendados al usar un registro en acciones, consulta Referencia de uso seguro.

Use el siguiente comando para autenticarse en GitHub Packages en un flujo de trabajo de GitHub Actions usando GITHUB_TOKEN en lugar de codificar de forma rígida un elemento personal access token en un archivo nuget.config del repositorio:

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"

Reemplace por NAMESPACE el nombre de la cuenta personal u organización a la que se los paquetes.

Reemplace USERNAME con el nombre de usuario que se usará al conectarse a un origen autenticado.

También puedes optar por conceder permisos de acceso a paquetes de forma independiente para GitHub Codespaces y GitHub Actions. Para más información, consulta Configurar la visibilidad y el control de accesos de un paquete y Configurar la visibilidad y el control de accesos de un paquete.

Autenticación con personal access token

Necesitas un token de acceso para publicar, instalar y eliminar paquetes privados, internos y públicos.

Puedes utilizar un personal access token (classic) para autenticarte en el GitHub Packages o en la API de GitHub. Cuando creas un personal access token (classic), puedes asignar al token diferentes ámbitos en función de tus necesidades. Para más información sobre los ámbitos relacionados con paquetes para un personal access token (classic), consulta Acerca de los permisos para los Paquetes de GitHub.

Para autenticarte en un registro del GitHub Packages dentro de un flujo de trabajo de GitHub Actions, puedes utilizar:

• GITHUB_TOKEN para publicar los paquetes asociados con el repositorio del flujo de trabajo.
• Un personal access token (classic) con al menos alcance read:packages para instalar los paquetes asociados con otros repositorios privados (GITHUB_TOKEN puede utilizarse si el repositorio tiene acceso de lectura al paquete. Consulta Configurar la visibilidad y el control de accesos de un paquete).

Debes utilizar un personal access token (classic) con los ámbitos adecuados para publicar e instalar paquetes en GitHub Packages. Para más información, consulta Introducción a los paquetes de GitHub.

Para autenticarse en GitHub Packages mediante la dotnet interfaz de línea de comandos (CLI), cree un archivo nuget.config en el directorio del proyecto en el que se especifique GitHub Packages como una fuente en packageSources para el cliente dotnet CLI.

Debes reemplazar:

• USERNAME con el nombre de su cuenta personal en GitHub.
• TOKEN con su personal access token (classic).
• NAMESPACE con el nombre de la cuenta personal u organización a la que pertenecen tus paquetes.

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

Publicación de un paquete

Puede publicar un paquete en GitHub Packages autenticándose con un archivo nuget.config, usando la opción de línea de comandos --api-key con su GitHubpersonal access token (classic), o mediante un comando que puede ejecutarse directamente desde la línea de comandos con la interfaz de línea de comandos (CLI) dotnet.

Sustituya OWNER por su nombre de usuario o el nombre de su empresa, y YOUR_GITHUB_PAT por su 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"

El registro de NuGet almacena paquetes en tu cuenta personal o de la organización y te permite asociar los paquetes a un repositorio. Puedes elegir si quieres heredar permisos desde un repositorio o si quieres configurar permisos granulares independientemente de un repositorio.

Cuando publicas un paquete por primera vez, la visibilidad predeterminada es privada. Para cambiar la visibilidad o establecer permisos de acceso, consulta Configurar la visibilidad y el control de accesos de un paquete. Para obtener más información sobre cómo vincular un paquete publicado con un repositorio, consulte Conectar un repositorio a un paquete.

Si especifica un RepositoryURL en el archivo .csproj del project, el paquete publicado se conectará automáticamente al repositorio especificado. Para obtener más información, vea Trabajar con el registro de NuGet. Para obtener información sobre cómo vincular un paquete ya publicado a un repositorio, consulte Conectar un repositorio a un paquete.

Publicar un paquete usando GitHub personal access token como tu clave de API

Si todavía no tiene un personal access token para usar con su cuenta en GitHub, consulte Administración de tokens de acceso personal.

1. Cree un nuevo proyecto. Reemplace PROJECT_NAME por el nombre que desea asignar al project.

   dotnet new console --name PROJECT_NAME
   

2. Empaqueta el proyecto.

   dotnet pack --configuration Release
   

3. Publique el paquete mediante personal access token como clave de API. Reemplace PROJECT_NAME por el nombre del proyecto, 1.0.0 por el número de versión del paquete y YOUR_GITHUB_PAT por personal access token.

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

Después de que publiques un paquete, puedes verlo en GitHub. Para más información, consulta Visualizar paquetes.

Publicación de un paquete mediante un archivo nuget.config

Al publicar, si va a vincular el paquete a un repositorio, la OWNER del repositorio especificado en el archivo .csproj debe coincidir con la NAMESPACE que usa en el archivo de autenticación nuget.config. Especifique o incremente el número de versión en el archivo .csproj y, a continuación, use el comando dotnet pack para crear un archivo .nuspec para esa versión. Para obtener más información sobre cómo crear el paquete, consulta Creación y publicación de un paquete en la documentación de Microsoft.

1. Autentícate en GitHub Packages. Para obtener más información, consulta Autenticación en GitHub Packages.

2. Cree un nuevo proyecto. Reemplace PROJECT_NAME por el nombre que desea asignar al project.

   dotnet new console --name PROJECT_NAME
   

3. Agregue la información específica de su proyecto al archivo del proyecto, que termina en .csproj. Asegúrese de reemplazar:

   • 1.0.0 con el número de versión del paquete.
   • OWNERcon el nombre de la cuenta personal o la organización que posee el repositorio al que desea vincular el paquete para publicar el paquete.
   • REPOSITORY con el nombre del repositorio al que desea conectar el paquete.

   <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. Empaqueta el proyecto.

   dotnet pack --configuration Release
   

5. Publique el paquete con el key que especificó en el archivo nuget.config. Reemplace PROJECT_NAME por el nombre del project y reemplace 1.0.0 por el número de versión del paquete.

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

Después de que publiques un paquete, puedes verlo en GitHub. Para más información, consulta Visualizar paquetes.

Publicar múltiples paquetes en el mismo repositorio

Para conectar varios paquetes al mismo repositorio, use la misma GitHub dirección URL del repositorio en los RepositoryURL campos de todos los archivos de proyecto .csproj . GitHub se corresponde con el repositorio según ese campo.

En el ejemplo siguiente se publican los proyectos MY_APP y MY_OTHER_APP en el mismo repositorio:

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

Instalación de un paquete

El uso de paquetes de GitHub en el proyecto es similar al uso de paquetes de nuget.org. Agregue las dependencias del paquete al archivo .csproj y especifique el nombre y la versión del paquete. Para obtener más información sobre el uso de un archivo .csproj en la project, consulte Working with NuGet packages en la documentación de Microsoft.

1. Autentícate en GitHub Packages. Para obtener más información, consulta Autenticación en GitHub Packages.

2. Para usar un paquete, agregue ItemGroup y configure el campo PackageReference en el archivo .csproj. Reemplace el valor PACKAGE_NAME de Include="PACKAGE_NAME" por la dependencia de su paquete, y sustituya el valor X.X.X de Version="X.X.X" por la versión del paquete que desea utilizar:

   <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 los paquetes con el comando restore.

   dotnet restore
   

Solución de problemas

Si utiliza un GITHUB_TOKEN para autenticarse en un registro de GitHub Packages dentro de un flujo de trabajo de GitHub Actions, el token no puede acceder a paquetes privados basados en repositorios de otro repositorio distinto de aquel en el que se ejecuta el flujo de trabajo. Para acceder a los paquetes asociados a otros repositorios, genere un personal access token (classic) con el ámbito read:packages y páselo como secreto.

Errores intermitentes 403 al restaurar paquetes públicos

Si usa GitHub Packages junto con nuget.org y experimenta errores intermitentes de 403 Prohibido al restaurar paquetes públicos estándar (como Microsoft.Extensions.*), esto puede ocurrir porque NuGet consulta todos los orígenes de paquetes configurados para cada paquete. Si GitHub Packages se produce un error de autenticación temporalmente, puede bloquear toda la restauración, incluso para los paquetes que no existen en GitHub Packages.

Para evitar esto, use la asignación de origen del paquete NuGet para enrutar paquetes a orígenes específicos.

Reemplazar:

• NAMESPACE con el nombre de la cuenta personal o la organización que es propietaria de tu GitHub Packages feed de NuGet.
• PACKAGE-ID-PREFIX con el prefijo de identificador de paquete de NuGet que se usa para los paquetes alojados en GitHub Packages. Si usa varios prefijos, agregue entradas adicionales <package> para cada prefijo.

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

NuGet usa el patrón de coincidencia más específico, por lo que los paquetes coincidentes PACKAGE-ID-PREFIX.* solo se capturan de GitHub Packages, mientras que todos los demás paquetes se capturan de nuget.org. Esto también ayuda a evitar ataques de confusión de dependencias asegurándose de que los paquetes privados solo pueden provenir de la GitHub Packages fuente.

Información adicional

• Borrar y restablecer un paquete