Skip to content

docs: Maven Central install steps and release steps - #72

Merged
zeevy merged 1 commit into
mainfrom
docs/70-install-steps
Oct 13, 2026
Merged

zeevy merged 1 commit into
mainfrom
docs/70-install-steps

Conversation

@zeevy

@zeevy zeevy commented Oct 13, 2026

Copy link
Copy Markdown
Owner

Follow-up to #71 now that 1.4.1 is on Maven Central. Refs #70.

Changes

  • README Installation: numbered steps. 1) mavenCentral() in settings.gradle.kts, 2) the dependency in Kotlin DSL, version catalog and Groovy, 3) sync, with no setup code. Plus a short "Moving from JitPack" part: new coordinates, no v in the version, drop the JitPack repository, do not keep both.
  • CONTRIBUTING: a "Releasing" section: version bump PR, GitHub Release v<version>, what release.yml does, and what to check before re-running a failed upload.
  • consumer-check: mavenCentral() now excludes com.siliconcircuits. The check depends on toaststack:+, and with 1.4.1 on Central, Gradle could resolve the released copy instead of the PR build.

How it was tested

  • PublicApiTest (README sample check) passes; the new Gradle blocks are skipped by its filter as before.
  • CI runs the consumer check against Maven Local with the new exclusion.
  • Release run for v1.4.1 was green, and Central took deployment b6917c63 to PUBLISHING.

- README Installation: numbered steps (repository, dependency in
  Kotlin DSL, version catalog and Groovy) and "Moving from JitPack".
- CONTRIBUTING: a Releasing section for the tag-driven Central upload.
- consumer-check takes com.siliconcircuits only from Maven Local, so
  the 1.4.1 copy on Central cannot stand in for the PR build.

Refs #70
@zeevy zeevy mentioned this pull request Oct 13, 2026
@zeevy
zeevy merged commit 34350b6 into main Oct 13, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant