Repository navigation
docs: mark the falco version in install snippets for release please - #103
Merged
Merged
Conversation
TheMeinerLP
force-pushed
the
docs/correct-stale-facts
branch
from
October 10, 2026 19:28
5ec2b43 to
92ca658
Compare
TheMeinerLP
force-pushed
the
docs/mark-falco-version
branch
from
October 10, 2026 19:29
698bd21 to
4841787
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Proposed changes
Stacked on #101 (
docs/correct-stale-facts); merge that one first.Marks every snippet in
README.mdanddocs/that states Falco's own current version, so Release Please can raise it together withbuild.gradle.kts. The markers are inert until the follow-up PR lists the three files underextra-files.README.md: the quick-start code block, wrapped in<!-- x-release-please-start-version -->/<!-- x-release-please-end -->outside the fence. The version also moves from 3.0.0 to 3.0.1, which is whatmainreleased.docs/how-to/add-falco-to-your-build.md: the BOM-and-modules block and the "without the BOM" block, wrapped the same way.docs/reference/modules-and-coordinates.md: the fiveCurrent versioncells, each with an inline<!-- x-release-please-version -->inside the cell.The markers are HTML comments outside the code fences, so neither GitHub nor GitBook shows them. Not marked on purpose: the tutorial snippet, because its block also names Minestom (
2026.10.07-26.2) and the generic updater replaces the first semver on every line of a marked block; theSincerows; examples such asfalco-anvil:1.0.0in build-setup.md, which are not the current version. Renovate catches the unmarked tutorial snippet (next PR).Types of changes
Checklist
./gradlew buildis not affected (Markdown only); the link and anchor check overdocs/reports no problemsFurther comments
Counter-check, run against the real updater (
release-please@latest,Generic.updateContentwith version9.8.7) on the files of this branch: exactly 1 line changed inREADME.md, 6 in the how-to page (the BOM line and the five module lines), 5 in the reference page (theCurrent versionrows), 0 in the unmarked tutorial. NoSincerow and no Minestom line changed.Not covered here: the Maven snippets of the how-to page live in #102. Their
falco-bomblock can take the same markers once #102 is rebased; the dependency block cannot, because it also contains the Minestom<version>. Renovate covers both (next PR).https://claude.ai/code/session_01Q6AxU7jRLmNPHdwg2GpasT