WPKit

1. Dodaj repozytorium pakietów1. Add the package repository

Dodaj repozytorium do dependencyResolutionManagement w pliku settings.gradle.kts. Dane dostępowe są pobierane wyłącznie ze zmiennych środowiskowych — dokumentacja celowo nie zawiera żadnych wartości kluczy.

Add the repository to dependencyResolutionManagement in settings.gradle.kts. Credentials are read only from environment variables—this documentation intentionally contains no key values.

dependencyResolutionManagement {
    repositories {
        google()
        mavenCentral()
        maven {
            url = uri("https://maven.pkg.github.com/nerdrip/wpkit")
            credentials {
                username = providers.environmentVariable("GITHUB_ACTOR").orNull
                password = providers.environmentVariable("GITHUB_TOKEN").orNull
            }
        }
    }
}

2. Wybierz kanał i dodaj zależność2. Choose a channel and add the dependency

Kotlin Multiplatform Stable 3.x

wpkit-core dodaj do commonMain. Gradle wybierze Ktor Android, CIO dla JVM/Desktop, Darwin dla iOS lub JS dla Wasm. Nie deklaruj ręcznie wygenerowanych współrzędnych -android, -jvm, -ios* ani -wasm-js.

Add wpkit-core to commonMain. Gradle selects Ktor Android, CIO for JVM/Desktop, Darwin for iOS or JS for Wasm. Do not declare generated -android, -jvm, -ios* or -wasm-js coordinates.

kotlin {
    sourceSets {
        commonMain.dependencies {
            implementation("rip.nerd.wpkit:wpkit-core:3.0.0")
        }
        androidMain.dependencies {
            // Optional legacy Views/Paging/Parse adapter:
            implementation("rip.nerd.wpkit:wpkit:3.0.0")
        }
    }
}

Snapshot 3.0.1

dependencies {
    implementation("rip.nerd.wpkit:wpkit-core:3.0.1-SNAPSHOT")
    implementation("rip.nerd.wpkit:wpkit:3.0.1-SNAPSHOT") // Android, optional
}

Katalog artefaktówArtifact catalog

Magazyny zależne od aplikacji są otwarte przez WPAccountStore, WPTokenStore i WPOutboxStore. Na iOS użyj Keychain dla sesji, na Androidzie szyfrowanego magazynu, a na Web własnej polityki IndexedDB/cookie. WPKit nie zapisuje tokenów do niezabezpieczonego localStorage i nie wymusza jednego dostawcy.

Application-specific persistence is open through WPAccountStore, WPTokenStore and WPOutboxStore. Use Keychain for sessions on iOS, encrypted storage on Android and an application-owned IndexedDB/cookie policy on Web. WPKit does not put tokens in unprotected localStorage or force one provider.

3. Zsynchronizuj i sprawdź projekt3. Sync and verify the project

Po zmianie zależności wykonaj synchronizację Gradle, a następnie zbuduj wariant debug aplikacji:

After changing the dependency, sync Gradle and build the app's debug variant:

./gradlew :app:assembleDebug

W systemie Windows użyj gradlew.bat zamiast ./gradlew.

On Windows, use gradlew.bat instead of ./gradlew.

Ręczna publikacja wersjiManual version publishing

Poniższe polecenia są przeznaczone dla opiekuna biblioteki. Wartości poświadczeń pozostają w środowisku lub magazynie sekretów i nie są częścią komendy.

The commands below are for library maintainers. Credential values remain in the environment or secret store and are never part of the command.

Snapshot z gałęzi developSnapshot from the develop branch

./gradlew :wpkit:publishAarPublicationToGitHubPackagesRepository :wpkit-core:publishAllPublicationsToGitHubPackagesRepository -Psnapshot=true --no-daemon

Buduje wariant deweloperski i publikuje wersję z sufiksem -SNAPSHOT.

Builds the development variant and publishes a version carrying the -SNAPSHOT suffix.

Wersja stabilna z main lub taga wydaniaStable version from main or a release tag

./gradlew :wpkit:publishAarPublicationToGitHubPackagesRepository :wpkit-core:publishAllPublicationsToGitHubPackagesRepository -Psnapshot=false --no-daemon

Buduje wariant release bez sufiksu. Uruchamiaj wyłącznie z czystego commita przeznaczonego do wydania.

Builds the release variant without a suffix. Run it only from a clean commit intended for release.

Lokalny snapshot do pracyLocal development snapshot

./gradlew :wpkit:publishAarPublicationToMavenLocal :wpkit-core:publishToMavenLocal -Psnapshot=true --no-daemon

Zadanie Maven Local publikuje linię 3.x z sufiksem -local-SNAPSHOT. POM androidowego adaptera wskazuje wtedy wyłącznie kitsunedb:3.0.1-local-SNAPSHOT i kitsunenet:3.0.1-local-SNAPSHOT, więc test nie miesza lokalnego WPKit ze zdalnymi zależnościami.

The Maven Local task publishes the 3.x line with the -local-SNAPSHOT suffix. The Android adapter POM then references only kitsunedb:3.0.1-local-SNAPSHOT and kitsunenet:3.0.1-local-SNAPSHOT, so the test never mixes local WPKit with remote dependencies.

Lokalna wersja produkcyjnaLocal production build

./gradlew :wpkit:publishAarPublicationToMavenLocal :wpkit-core:publishToMavenLocal -Psnapshot=false --no-daemon

Publikuje wariant release jako rip.nerd.wpkit:wpkit:3.0.0-local. Wersja produkcyjna lokalna nie ma sufiksu -SNAPSHOT.

Publishes the release variant as rip.nerd.wpkit:wpkit:3.0.0-local. A local production build never carries the -SNAPSHOT suffix.

repositories { mavenLocal() }

dependencies {
    implementation("rip.nerd.wpkit:wpkit:3.0.1-local-SNAPSHOT")
}

ZasadyRules

• *MavenLocal* zawsze dodaje -local; opcja -Plocal=true służy tylko do podglądu wersji, np. przez printPublicationVersion.*MavenLocal* always adds -local; -Plocal=true is only needed to inspect the version, for example with printPublicationVersion.
• Artefaktów -local nie wolno wysyłać do współdzielonego repozytorium; build zdalnej publikacji jest przed tym zabezpieczony.-local artifacts must never be uploaded to a shared repository; remote publishing fails fast if this is attempted.
• -local-SNAPSHOT jest nadpisywalny. Przed opublikowaniem zmienionej wersji -local bez Snapshot należy podnieść baseVersion.-local-SNAPSHOT is replaceable. Bump baseVersion before publishing changed -local content without Snapshot.
• Po wydaniu 3.0.0 gałąź develop publikuje 3.0.1-SNAPSHOT; wersje stabilne powstają wyłącznie z tagów wydania.After the 3.0.0 release, develop publishes 3.0.1-SNAPSHOT; stable versions are created only from release tags.