Uso del registro de Gradle

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

Para más información sobre el uso de GITHUB_TOKEN en flujos de trabajo de GitHub Actions, consulta Uso de GITHUB_TOKEN para la autenticación en flujos de trabajo. Para obtener más información sobre el uso GITHUB_TOKEN con Gradle, consulte Publicación de paquetes de Java con Gradle.

Autenticación con personal access token

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.

Puede autenticarse en GitHub Packages con Gradle usando Gradle Groovy o Kotlin DSL; para ello, edite el archivo build.gradle (Gradle Groovy) o el archivo build.gradle.kts (Kotlin DSL) para incluir su personal access token (classic). También puedes configurar Gradle Groovy y Kotlin DSL para que reconozcan un paquete único o múltiples paquetes en un repositorio.

Reemplace REGISTRY_URL por la dirección URL del registro de Maven de la instancia. Si en la instancia se ha habilitado el aislamiento de subdominios, use maven.HOSTNAME. Si en la instancia se ha deshabilitado el aislamiento de subdominios, use HOSTNAME/_registry/maven. En cualquier caso, reemplace HOSTNAME por el nombre de host de la GitHub Enterprise Server instancia.

Reemplace USERNAME por su GitHub nombre de usuario, TOKEN por su personal access token (classic), REPOSITORY por el nombre del repositorio que contiene el paquete que desea publicar y OWNER por el nombre de la cuenta personal u organización en GitHub que es propietaria del repositorio. Dado que no se admiten letras mayúsculas, debe usar letras minúsculas para el propietario del repositorio incluso si el nombre del usuario o la GitHub organización contiene letras mayúsculas.

Ejemplo de uso de Gradle Groovy para un paquete único en un repositorio

plugins {
    id("maven-publish")
}
publishing {
    repositories {
        maven {
            name = "GitHubPackages"
            url = uri("https://REGISTRY_URL/OWNER/REPOSITORY")
            credentials {
                username = project.findProperty("gpr.user") ?: System.getenv("USERNAME")
                password = project.findProperty("gpr.key") ?: System.getenv("TOKEN")
            }
        }
    }
    publications {
        gpr(MavenPublication) {
            from(components.java)
        }
    }
}

Ejemplo usando Gradle Groovy para múltiples paquetes en el mismo repositorio

plugins {
    id("maven-publish") apply false
}
subprojects {
    apply plugin: "maven-publish"
    publishing {
        repositories {
            maven {
                name = "GitHubPackages"
                url = uri("https://REGISTRY_URL/OWNER/REPOSITORY")
                credentials {
                    username = project.findProperty("gpr.user") ?: System.getenv("USERNAME")
                    password = project.findProperty("gpr.key") ?: System.getenv("TOKEN")
                }
            }
        }
        publications {
            gpr(MavenPublication) {
                from(components.java)
            }
        }
    }
}

Ejemplo de uso de Kotlin DSL para un paquete único en el mismo repositorio

plugins {
    `maven-publish`
}
publishing {
    repositories {
        maven {
            name = "GitHubPackages"
            url = uri("https://REGISTRY_URL/OWNER/REPOSITORY")
            credentials {
                username = project.findProperty("gpr.user") as String? ?: System.getenv("USERNAME")
                password = project.findProperty("gpr.key") as String? ?: System.getenv("TOKEN")
            }
        }
    }
    publications {
        register<MavenPublication>("gpr") {
            from(components["java"])
        }
    }
}

Ejemplo de uso de Kotlin DSL para múltiples paquetes en el mismo repositorio

plugins {
    `maven-publish` apply false
}
subprojects {
    apply(plugin = "maven-publish")
    configure<PublishingExtension> {
        repositories {
            maven {
                name = "GitHubPackages"
                url = uri("https://REGISTRY_URL/OWNER/REPOSITORY")
                credentials {
                    username = project.findProperty("gpr.user") as String? ?: System.getenv("USERNAME")
                    password = project.findProperty("gpr.key") as String? ?: System.getenv("TOKEN")
                }
            }
        }
        publications {
            register<MavenPublication>("gpr") {
                from(components["java"])
            }
        }
    }
}

Publicación de un paquete

Predeterminadamente, GitHub publica el paquete en un repositorio existente con el mismo nombre que éste. Por ejemplo, GitHub publicará un paquete denominado com.example.test en el OWNER/testGitHub Packages repositorio.

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

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

2. Después de crear tu paquete, puedes publicar el paquete.

    gradle publish
   

Utilizar un paquete publicado

Para usar un paquete publicado desde GitHub Packages, agregue el paquete como dependencia y agregue el repositorio al proyecto. Para más información, consulta Declaración de dependencias en la documentación de Gradle.

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

2. Agregue las dependencias del paquete al archivo build.gradle (Gradle Groovy) o al archivo build.gradle.kts (Kotlin DSL).

   Ejemplo utilizando Gradle Groovy:

   dependencies {
       implementation 'com.example:package'
   }
   

   Ejemplo de uso de Kotlin DSL:

   dependencies {
       implementation("com.example:package")
   }
   

3. Agregue el repositorio al archivo build.gradle (Gradle Groovy) o al archivo build.gradle.kts (Kotlin DSL).

   Ejemplo utilizando Gradle Groovy:

   repositories {
       maven {
           url = uri("https://REGISTRY_URL/OWNER/REPOSITORY")
           credentials {
               username = project.findProperty("gpr.user") ?: System.getenv("USERNAME")
               password = project.findProperty("gpr.key") ?: System.getenv("TOKEN")
           }
      }
   }
   

   Ejemplo de uso de Kotlin DSL:

   repositories {
       maven {
           url = uri("https://REGISTRY_URL/OWNER/REPOSITORY")
           credentials {
               username = project.findProperty("gpr.user") as String? ?: System.getenv("USERNAME")
               password = project.findProperty("gpr.key") as String? ?: System.getenv("TOKEN")
           }
       }
   }
   

Información adicional

• Trabajar con el registro de Apache Maven
• Borrar y restablecer un paquete