Skip to content

docs: mark the falco version in install snippets for release please #103

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
TheMeinerLP merged 1 commit into from
Oct 10, 2026
Merged

docs: mark the falco version in install snippets for release please #103

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 3 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ From nothing to a server that serves a stored world, in five steps. Step 4 needs

### 1. Declare the dependency

<!-- x-release-please-start-version -->
```kotlin
repositories {
mavenCentral()
Expand All @@ -39,7 +40,7 @@ repositories {

dependencies {
// One version for all three, so they cannot drift into a combination nobody tested.
implementation(platform("net.onelitefeather:falco-bom:3.0.0"))
implementation(platform("net.onelitefeather:falco-bom:3.0.1"))

implementation("net.onelitefeather:falco-anvil") // reading and writing Anvil worlds
implementation("net.onelitefeather:falco-light") // block and sky light
Expand All @@ -52,6 +53,7 @@ dependencies {
implementation("net.minestom:minestom:<version>")
}
```
<!-- x-release-please-end -->

Take only the modules you need — a platform constrains a version for each, it does not pull one in.
Steps 2 to 4 below use the first two; step 5 uses all three. Individual coordinates, Maven and
Expand Down
6 changes: 6 additions & 0 deletions docs/how-to/add-falco-to-your-build.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ snapshot endpoints are both public.

2. Import `falco-bom` as a platform and declare the modules you need without versions:

<!-- x-release-please-start-version -->

```kotlin
dependencies {
implementation(platform("net.onelitefeather:falco-bom:3.0.1"))
Expand All @@ -30,6 +32,8 @@ snapshot endpoints are both public.
}
```

<!-- x-release-please-end -->

Take only the modules you need. The platform constrains a version for `falco-anvil`, `falco-light`
and `falco-instance`; it does not pull in one you did not declare, and it does not cover
`falco-migration`.
Expand All @@ -46,6 +50,7 @@ snapshot endpoints are both public.

Version each module individually instead of step 2:

<!-- x-release-please-start-version -->
```kotlin
dependencies {
implementation("net.onelitefeather:falco-anvil:3.0.1")
Expand All @@ -54,6 +59,7 @@ dependencies {
implementation("net.onelitefeather:falco-migration:3.0.1")
}
```
<!-- x-release-please-end -->

Use this only if your build cannot import a platform. Versioning the modules by hand lets them drift
into a combination that was never built or tested together.
Expand Down
10 changes: 5 additions & 5 deletions docs/reference/modules-and-coordinates.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Consuming Falco needs no credentials. Only building Falco itself does — see
| | |
| --- | --- |
| Kind | `java-library` |
| Current version | `3.0.1` |
| Current version | `3.0.1` <!-- x-release-please-version --> |
| Since | `0.1.0` |
| Javadoc | [latest release](https://repo.onelitefeather.dev/javadoc/releases/net/onelitefeather/falco-anvil/latest) |

Expand All @@ -39,7 +39,7 @@ An Anvil region-file chunk loader for Minestom.
| | |
| --- | --- |
| Kind | `java-library` |
| Current version | `3.0.1` |
| Current version | `3.0.1` <!-- x-release-please-version --> |
| Since | `0.1.0` |
| Javadoc | [latest release](https://repo.onelitefeather.dev/javadoc/releases/net/onelitefeather/falco-light/latest) |

Expand All @@ -50,7 +50,7 @@ A block- and sky-light engine for Minestom.
| | |
| --- | --- |
| Kind | `java-library` |
| Current version | `3.0.1` |
| Current version | `3.0.1` <!-- x-release-please-version --> |
| Since | `0.1.0` |
| Javadoc | [latest release](https://repo.onelitefeather.dev/javadoc/releases/net/onelitefeather/falco-instance/latest) |

Expand All @@ -62,7 +62,7 @@ sections on demand.
| | |
| --- | --- |
| Kind | `java-library` |
| Current version | `3.0.1` |
| Current version | `3.0.1` <!-- x-release-please-version --> |
| Since | `2.0.0` |
| Javadoc | not yet rendered at a stable address |

Expand All @@ -74,7 +74,7 @@ Lifts a world older than the running server to it. Needed only when loading such
| | |
| --- | --- |
| Kind | `java-platform` |
| Current version | `3.0.1` |
| Current version | `3.0.1` <!-- x-release-please-version --> |
| Since | `1.0.0` |
| Javadoc | none — the artefact carries no classes |

Expand Down
Loading