Skip to content
This repository was archived by the owner on Mar 23, 2026. It is now read-only.

docs: professional documentation, configuration guide and CI/CD automation#6

Merged
devzucca merged 10 commits intomainfrom
dev
Mar 18, 2026
Merged

docs: professional documentation, configuration guide and CI/CD automation#6
devzucca merged 10 commits intomainfrom
dev

Conversation

@devzucca
Copy link
Copy Markdown
Owner

Resumen

Mejoras profesionales a la documentación del proyecto.

README.md

  • Estructura profesional con índice completo
  • Sección de configuración del entorno destacada con tabla de variables
  • Documentación de CI/CD (qué hace cada job, qué secrets necesita)
  • Modelo de ramas (main/dev/feature)
  • Template local.properties.example para onboarding

Documentación interna (docs/ES/)

  • Coordenadas corregidas: devzucca/appLoggers (antes TuOrganizacion/app-logger)
  • Versión corregida: 0.1.0-alpha.1 (antes 0.1.1)
  • Referencias de rama: dev (antes develop)
  • Badges actualizados (Kotlin 2.1, API 23)

Otros

  • AppLogger.podspec y Package.swift con URLs correctas
  • CHANGELOG.md actualizado con hitos de monorepo y JitPack
  • E2E test version string actualizado

Tests

  • Compilación: BUILD SUCCESSFUL (3 módulos)
  • Tests unitarios: PASSED (logger-core, logger-test)
  • Tests E2E: PASSED (logger-transport-supabase)

…ng model

- Rewrite README with professional structure and table of contents
- Add prominent configuration section with local.properties setup
- Document all required GitHub Secrets for CI pipeline
- Add CI/CD automation section explaining push/tag behavior
- Add branching strategy (main/develop/feature) with workflow
- Add local.properties.example template for onboarding
- Fix JitPack dependency coordinates with v-prefix
- Link to sdk/gradle/libs.versions.toml instead of root
- Update CI workflow branches (main, dev)
- Update README branching documentation to use dev
- Replace TuOrganizacion/app-logger → devzucca/appLoggers in all docs
- Update version 0.1.1 → 0.1.0-alpha.1 across all files
- Replace develop → dev branch references in CONTRIBUTING and publishing
- Fix dependency coordinates to use actual JitPack format
- Update AppLogger.podspec and Package.swift with correct GitHub URLs
- Update CHANGELOG.md with monorepo and JitPack milestones
- Fix architecture.md dependency examples with real coordinates
- Update E2E test version string
Copilot AI review requested due to automatic review settings March 18, 2026 21:10
- Set executable permission on sdk/gradlew (100644 → 100755)
- Add gradle-project-path: sdk for mikepenz/gradle-dependency-submission
- Add contents: write permission for dependency submission job
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR professionalizes and aligns project documentation/configuration with the current repository identity (devzucca/appLoggers), branching model (dev), and the intended release/version (0.1.0-alpha.1), plus small updates to CI and distribution metadata.

Changes:

  • Updated documentation references (URLs, coordinates, badges, branching model) and version strings to 0.1.0-alpha.1.
  • Added local.properties.example and expanded root README with environment configuration + CI/CD guidance.
  • Updated CI workflow branch filters (developdev) and refreshed iOS distribution metadata references.

Reviewed changes

Copilot reviewed 16 out of 17 changed files in this pull request and generated 5 comments.

Show a summary per file
File Description
sdk/logger-transport-supabase/src/jvmTest/kotlin/com/applogger/transport/supabase/SupabaseE2ETest.kt Updates E2E test appVersion string to 0.1.0-alpha.1.
sdk/Package.swift Updates the commented remote XCFramework URL to the new repo + version.
sdk/AppLogger.podspec Updates homepage/author/source URLs to the new repo.
local.properties.example Adds an onboarding template for local SDK + Supabase configuration.
docs/ES/paquete/testing.md Updates documented version to 0.1.0-alpha.1.
docs/ES/paquete/publishing.md Updates publishing guide to new coordinates/repo/branch model/version.
docs/ES/paquete/architecture.md Updates repo/module naming and dependency examples to new coordinates/version.
docs/ES/paquete/README.md Updates badges/links and supported API/Kotlin badge values.
docs/ES/paquete/CONTRIBUTING.md Updates clone/upstream URLs and branch model (developdev).
docs/ES/paquete/CHANGELOG.md Renames release section and updates GitHub compare/tag links to new repo/version.
docs/ES/desarrollo/monitoring-app.md Updates documented version to 0.1.0-alpha.1.
docs/ES/desarrollo/integration-guide.md Updates dependency coordinates to new group/repo naming.
docs/ES/desarrollo/api-compatibility.md Updates documented version to 0.1.0-alpha.1.
README.md Major README expansion: TOC, env setup, CI/CD, branching, publishing, dependencies.
CHANGELOG.md Reworks [Unreleased] section and renames release to 0.1.0-alpha.1.
.github/workflows/ci.yml Updates workflow branch filters to main + dev.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread CHANGELOG.md Outdated
Comment on lines +12 to +15
- Módulo `logger-transport-firebase` — transporte a Firebase Realtime Database
- Soporte para `logger-transport-grpc` — envío directo vía gRPC a un servidor custom
- Soporte Wear OS en `PlatformDetector`
- Dashboard web de visualización de logs en tiempo real
Comment thread README.md Outdated

- [Estructura del Repositorio](#estructura-del-repositorio)
- [Características](#características)
- [⚙️ Configuración del Entorno](#️-configuración-del-entorno)
Comment thread docs/ES/desarrollo/integration-guide.md Outdated
Comment on lines +79 to +85
```kotlin
dependencies {
// Core del logger (obligatorio)
implementation("com.github.TuOrganizacion:app-logger:0.1.1")
implementation("com.github.devzucca.appLoggers:logger-core:0.1.0-alpha.1")

// Módulo de transporte Supabase (opcional — incluido en el core)
// implementation("com.github.TuOrganizacion:app-logger-supabase:0.1.1")
// implementation("com.github.devzucca.appLoggers:logger-transport-supabase:0.1.0-alpha.1")
Comment thread sdk/AppLogger.podspec Outdated
s.author = { 'ZuccaDev' => 'zuccadev@github.com' }
s.source = { :http => "https://github.com/zuccadev/app-logger/releases/download/#{s.version}/AppLogger.xcframework.zip" }
s.author = { 'DevZucca' => 'devzucca@github.com' }
s.source = { :http => "https://github.com/devzucca/appLoggers/releases/download/#{s.version}/AppLogger.xcframework.zip" }
Comment thread docs/ES/paquete/publishing.md Outdated
VERSION_NAME=0.1.0-alpha.1

POM_NAME=AppLogger
POM_NAME=AppLoggers
- BatchProcessor: extract handleFailure() to reduce nesting depth
- BatchProcessor: suppress UnusedPrivateProperty on formatter (reserved for future use)
- AndroidDeviceInfoProvider: suppress ReturnCount + CyclomaticComplexMethod on getConnectionType
- SupabaseTransport: add @Suppress for TooGenericExceptionCaught on send()
- SupabaseTransport: RuntimeException -> error() (UseCheckOrError)
- SupabaseTransport: rename snake_case fields to camelCase + @SerialName for DB compat
- SupabaseTransport: add ListSerializer import and break long setBody lines (MaxLineLength)
- FakeTransport: RuntimeException -> error() (UseCheckOrError)
- detekt.yml: extend MagicNumber ignoreNumbers (HTTP codes, time constants, limits)
- detekt.yml: extend WildcardImport excludeImports for internal and ktor packages
- CHANGELOG.md: translate Planned section to English (Copilot review)
- README.md: fix broken TOC anchor for Configuracion section (Copilot review)
- integration-guide.md: add v prefix to JitPack version coordinates (Copilot review)
- AppLogger.podspec: add v prefix to release download URL (Copilot review)
- publishing.md: fix POM_NAME AppLoggers -> AppLogger (Copilot review)
- .githooks/pre-push: runs Detekt + jvmTest before every push (blocks CI failures)
- .actrc: project-level act config with catthehacker image mappings
- .act.secrets.example: template for local CI secrets (do not commit .act.secrets)
- .gitignore: add .act.secrets to ignored files
- docs/ES/paquete/dev-environment.md: complete dev environment setup guide
  (JDK, Android SDK, Docker, act, git hooks, daily workflow, troubleshooting)
- docs/ES/paquete/CONTRIBUTING.md: simplify setup section, link to new guide
@devzucca devzucca merged commit 1083590 into main Mar 18, 2026
9 checks passed
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants