Skip to content

Update Deployment section in README #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
boronine merged 2 commits into from
Aug 16, 2026
Merged

Update Deployment section in README #6

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
88b9e76
Update Deployment section in README
boronine-bot Aug 16, 2026
f63d823
Modernize README badges
boronine-bot Aug 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 16 additions & 28 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[![Build Status](https://github.com/hsluv/hsluv-java/actions/workflows/test.yml/badge.svg)](https://github.com/hsluv/hsluv-java/actions/workflows/test.yml)
[![Package Version](https://img.shields.io/maven-central/v/org.hsluv/hsluv.svg)](http://repo1.maven.org/maven2/org/hsluv/hsluv/)
[![Javadocs](http://www.javadoc.io/badge/org.hsluv/hsluv.svg)](http://www.javadoc.io/doc/org.hsluv/hsluv)
[![Build Status](https://github.com/hsluv/hsluv-java/actions/workflows/test.yml/badge.svg?branch=master)](https://github.com/hsluv/hsluv-java/actions/workflows/test.yml)
[![Maven Central](https://img.shields.io/maven-central/v/org.hsluv/hsluv)](https://central.sonatype.com/artifact/org.hsluv/hsluv)
[![Javadoc](https://javadoc.io/badge2/org.hsluv/hsluv/javadoc.svg)](https://javadoc.io/doc/org.hsluv/hsluv)

About: http://www.hsluv.org

Expand Down Expand Up @@ -71,33 +71,21 @@ var color = android.graphics.Color.rgb(r, g, b);

# Deployment

Docs:

- https://central.sonatype.org/publish/publish-portal-maven/
- https://central.sonatype.org/publish/requirements/gpg/
- https://central.sonatype.org/publish/generate-portal-token/

Generate a Portal token at https://central.sonatype.com, then set `~/.m2/settings.xml`:

```xml
<settings>
<servers>
<server>
<id>central</id>
<username><!-- your token username --></username>
<password><!-- your token password --></password>
</server>
<server>
<id>D7771F55ED62AAC7162CFDE833B20E4440CDF36D</id>
<passphrase><!-- your GPG key passphrase --></passphrase>
</server>
</servers>
</settings>
Releases are published to Maven Central by the [`release.yml`](.github/workflows/release.yml)
workflow, triggered by a `v*` tag.

One-time setup: generate a Portal token at https://central.sonatype.com, then store the
credentials as repo secrets:

```bash
gh secret set GPG_PRIVATE_KEY --repo hsluv/hsluv-java < signing-key.asc
gh secret set GPG_PASSPHRASE --repo hsluv/hsluv-java --body "<passphrase>"
gh secret set CENTRAL_TOKEN_USERNAME --repo hsluv/hsluv-java --body "<token username>"
gh secret set CENTRAL_TOKEN_PASSWORD --repo hsluv/hsluv-java --body "<token password>"
```

Then run:
Then bump the version in `pom.xml` and create a release:

```bash
mvn versions:set -DnewVersion=1.0.1 # bump version
mvn clean deploy
gh release create v1.0.1 --generate-notes
```