Skip to content

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

Merged
TheMeinerLP merged 1 commit into
mainfrom
docs/mark-falco-version
Oct 10, 2026
Merged

TheMeinerLP merged 1 commit into
mainfrom
docs/mark-falco-version

Conversation

@TheMeinerLP

Copy link
Copy Markdown
Contributor

Proposed changes

Stacked on #101 (docs/correct-stale-facts); merge that one first.

Marks every snippet in README.md and docs/ that states Falco's own current version, so Release Please can raise it together with build.gradle.kts. The markers are inert until the follow-up PR lists the three files under extra-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 what main released.
  • 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 five Current version cells, 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; the Since rows; examples such as falco-anvil:1.0.0 in build-setup.md, which are not the current version. Renovate catches the unmarked tutorial snippet (next PR).

Types of changes

  • Documentation Update (if none of the other choices apply)

Checklist

  • The title of this pull request is a Conventional Commit
  • ./gradlew build is not affected (Markdown only); the link and anchor check over docs/ reports no problems

Further comments

Counter-check, run against the real updater (release-please@latest, Generic.updateContent with version 9.8.7) on the files of this branch: exactly 1 line changed in README.md, 6 in the how-to page (the BOM line and the five module lines), 5 in the reference page (the Current version rows), 0 in the unmarked tutorial. No Since row and no Minestom line changed.

Not covered here: the Maven snippets of the how-to page live in #102. Their falco-bom block 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

@TheMeinerLP
TheMeinerLP requested a review from a team as a code owner October 10, 2026 18:47
@TheMeinerLP
TheMeinerLP force-pushed the docs/correct-stale-facts branch from 5ec2b43 to 92ca658 Compare October 10, 2026 19:28
@TheMeinerLP
TheMeinerLP changed the base branch from docs/correct-stale-facts to main October 10, 2026 19:29
@TheMeinerLP
TheMeinerLP force-pushed the docs/mark-falco-version branch from 698bd21 to 4841787 Compare October 10, 2026 19:29
@TheMeinerLP
TheMeinerLP merged commit 8166878 into main Oct 10, 2026
4 checks passed
@TheMeinerLP
TheMeinerLP deleted the docs/mark-falco-version branch October 10, 2026 19:29
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