fmt

Author: zeevmoney

PUBLISHING.md

@@ -5,18 +5,22 @@ This document describes how to publish the Permit.io Java SDK to Maven Central a
 ## Overview
 
 The SDK is published to two repositories:
+
 - **Maven Central** - Primary distribution for public consumption
 - **GitHub Packages** - Secondary distribution for GitHub-based workflows
 
 ## Prerequisites
 
 ### Maven Central Portal Account
+
 1. Create an account at [central.sonatype.com](https://central.sonatype.com)
 2. Verify ownership of the `io.permit` namespace
 3. Generate a User Token: Account → Generate User Token
 
 ### GPG Signing Key
+
 Maven Central requires all artifacts to be signed with GPG:
+
 ```bash
 # Generate a key (if you don't have one)
 gpg --full-generate-key
@@ -29,48 +33,58 @@ gpg --armor --export-secret-keys YOUR_KEY_ID | base64
 
 Configure these secrets in your GitHub repository:
 
-| Secret | Description |
-|--------|-------------|
+| Secret                   | Description                        |
+|--------------------------|------------------------------------|
 | `MAVEN_CENTRAL_USERNAME` | Username from Central Portal token |
 | `MAVEN_CENTRAL_PASSWORD` | Password from Central Portal token |
-| `GPG_SIGNING_KEY` | Base64-encoded GPG private key |
-| `GPG_SIGNING_PASSPHRASE` | Passphrase for the GPG key |
+| `GPG_SIGNING_KEY`        | Base64-encoded GPG private key     |
+| `GPG_SIGNING_PASSPHRASE` | Passphrase for the GPG key         |
 
 ## Publishing Methods
 
 ### Automatic (CI/CD)
 
 Publishing is triggered automatically when:
+
 - A GitHub Release is created
 - The workflow is manually dispatched
 
 The workflow (`.github/workflows/publish.yaml`) handles:
+
 1. Javadoc verification
 2. Publishing to GitHub Packages
 3. Publishing to Maven Central
 
 ### Manual (Local)
 
 #### Publish to Local Maven Repository
+
 Test artifact generation without uploading:
+
 ```bash
 ./gradlew publishToMavenLocal
 ```
+
 Artifacts are published to `~/.m2/repository/io/permit/permit-sdk-java/`
 
 #### Publish to Maven Central (Staging Only)
+
 Upload to Central Portal without releasing:
+
 ```bash
 ./gradlew publishToMavenCentral \
   -PmavenCentralUsername=USERNAME \
   -PmavenCentralPassword=PASSWORD \
   -PsigningInMemoryKey="$(cat key.asc)" \
   -PsigningInMemoryKeyPassword=PASSPHRASE
 ```
+
 Review at [Central Portal Deployments](https://central.sonatype.com/publishing/deployments)
 
 #### Publish and Release to Maven Central
+
 Full publish with automatic release:
+
 ```bash
 ./gradlew publishAndReleaseToMavenCentral \
   -PmavenCentralUsername=USERNAME \
@@ -80,6 +94,7 @@ Full publish with automatic release:
 ```
 
 #### Publish to GitHub Packages
+
 ```bash
 GITHUB_ACTOR=username GITHUB_TOKEN=token ./gradlew publish
 ```
@@ -89,40 +104,49 @@ GITHUB_ACTOR=username GITHUB_TOKEN=token ./gradlew publish
 The `mavenPublishing` block in `build.gradle` supports different publishing modes:
 
 ### CENTRAL_PORTAL (Current)
+
 ```groovy
 publishToMavenCentral(SonatypeHost.CENTRAL_PORTAL)
 ```
-Uses the new Maven Central Portal API at `central.sonatype.com`. This is the current recommended method as Sonatype has deprecated the legacy OSSRH system.
+
+Uses the new Maven Central Portal API at `central.sonatype.com`. This is the current recommended method as Sonatype has
+deprecated the legacy OSSRH system.
 
 ### S01 (Legacy OSSRH)
+
 ```groovy
 publishToMavenCentral(SonatypeHost.S01)
 ```
+
 Uses the legacy Sonatype OSSRH at `s01.oss.sonatype.org`. This method is deprecated and may stop working.
 
 ### DEFAULT (Legacy OSSRH)
+
 ```groovy
 publishToMavenCentral(SonatypeHost.DEFAULT)
 ```
+
 Uses the original Sonatype OSSRH at `oss.sonatype.org`. This is for older projects and is deprecated.
 
 ## Gradle Tasks
 
-| Task | Description |
-|------|-------------|
-| `publishToMavenLocal` | Publish to local Maven cache (~/.m2) |
-| `publishToMavenCentral` | Upload to Central Portal (staging) |
-| `publishAndReleaseToMavenCentral` | Upload and release to Maven Central |
-| `publish` | Publish to all configured repositories (GitHub Packages) |
+| Task                              | Description                                              |
+|-----------------------------------|----------------------------------------------------------|
+| `publishToMavenLocal`             | Publish to local Maven cache (~/.m2)                     |
+| `publishToMavenCentral`           | Upload to Central Portal (staging)                       |
+| `publishAndReleaseToMavenCentral` | Upload and release to Maven Central                      |
+| `publish`                         | Publish to all configured repositories (GitHub Packages) |
 
 ## Versioning
 
 Version is automatically determined by the `com.palantir.git-version` plugin based on git tags:
+
 - Tagged commit: `2.2.0`
 - Commits after tag: `2.2.0-1-gabcdef`
 - Dirty working directory: `2.2.0-1-gabcdef.dirty`
 
 To release a new version:
+
 ```bash
 git tag 2.3.0
 git push origin 2.3.0
@@ -131,14 +155,17 @@ git push origin 2.3.0
 ## Troubleshooting
 
 ### 403 Forbidden
+
 - Credentials may be invalid or expired
 - Regenerate token at Central Portal
 
 ### Signature Verification Failed
+
 - GPG key may be malformed
 - Ensure key is base64 encoded without line breaks
 
 ### Version Already Exists
+
 - Maven Central doesn't allow overwriting versions
 - Bump the version and try again