Skip to content

Latest commit

 

History

History
110 lines (80 loc) · 4.12 KB

CONTRIBUTING.md

File metadata and controls

110 lines (80 loc) · 4.12 KB

Contribuir

Compilación

La compilación usa JDK 25 por defecto y genera bytecode Java 17.

./gradlew clean build

Para compilar y ejecutar los tests con otro JDK instalado:

./gradlew clean build -PjavaVersion=17
./gradlew clean build -PjavaVersion=21

El wrapper incluye Gradle 9.8.1 y verifica el SHA-256 de su distribución. Los tests usan un servidor HTTP local con puerto efímero; no necesitan la API en producción ni un servicio en localhost:8080.

Formato y análisis estático

  • Spotless aplica Palantir Java Format a todas las fuentes Java, incluidos los tests, y formatea los archivos Gradle con Groovy Eclipse.
  • PMD analiza producción y tests con las reglas de config/pmd/ruleset.xml: errores de igualdad, excepciones, recursos, código sin uso y operaciones redundantes.
  • El compilador activa -Xlint:all y trata las advertencias como errores.
./gradlew spotlessApply            # Aplicar el formato
./gradlew spotlessCheck            # Comprobar el formato
./gradlew pmdMain pmdTest          # Analizar producción y tests
./gradlew check                    # Formato, análisis y tests

build incluye todas estas comprobaciones. Funcionan con los tres JDK admitidos; puedes añadir -PjavaVersion=17 o -PjavaVersion=21 a los comandos anteriores. Las herramientas de calidad son dependencias del build y no se publican como dependencias del cliente.

Probar desde otro proyecto

Para probar cambios sin publicar, clona este repositorio junto al proyecto consumidor y agrega a su settings.gradle:

includeBuild("../tu-ruc-java-client")

Gradle sustituye py.com.ith:tu-ruc-client por el checkout local. Con la configuración por defecto necesitas JDK 25 instalado.

Para revisar los artefactos que se publicarían, sin firmarlos:

./gradlew publishToMavenLocal

Quedan en ~/.m2/repository/py/com/ith/tu-ruc-client/.

Integración continua

CI ejecuta ./gradlew clean build con Java 17, 21 y 25 y falla si alguna comprobación detecta un problema.

Dependencias

Retrofit se declara como dependencia api porque los métodos públicos devuelven retrofit2.Call. El BOM de OkHttp también se expone para alinear sus tipos transitivos entre la compilación del consumidor y la ejecución. La conversión JSON usa el módulo oficial fastjson2-extension, que incluye el conversor para Retrofit.

Publicación

La biblioteca se publica en Maven Central con el plugin com.vanniktech.maven.publish. Maven Central rechaza artefactos sin firmar, por eso la publicación exige la clave PGP.

Para publicar:

  1. Sube version en build.gradle y registra los cambios en CHANGELOG.md.

  2. Crea y sube un tag con la misma versión, sin v:

    git tag -a 0.1.0 -m "Tu RUC Java Client 0.1.0"
    git push origin 0.1.0

CI ejecuta las comprobaciones con Java 17, 21 y 25, verifica que el tag coincida con la versión y publica en Maven Central. Una versión publicada no se puede borrar ni reemplazar.

El workflow usa estos secretos del repositorio:

Secreto Contenido
MAVEN_CENTRAL_USERNAME Usuario del token de Central Portal con acceso a py.com.ith
MAVEN_CENTRAL_PASSWORD Contraseña de ese token
SIGNING_KEY Clave privada PGP exportada en ASCII (gpg --armor --export-secret-keys)
SIGNING_KEY_PASSWORD Frase de la clave PGP

La clave pública debe estar en un servidor de claves que Maven Central consulte, como keys.openpgp.org o keyserver.ubuntu.com.