Skip to content

chore(release): bump the falco version in docs with each release - #104

Merged
TheMeinerLP merged 1 commit into
mainfrom
chore/docs-version-automation
Oct 10, 2026
Merged

TheMeinerLP merged 1 commit into
mainfrom
chore/docs-version-automation

Conversation

@TheMeinerLP

Copy link
Copy Markdown
Contributor

Proposed changes

Stacked on docs: mark the falco version in install snippets for release please (branch docs/mark-falco-version), which itself sits on #101; merge in that order.

Keeps Falco's own version in the docs current without a manual pass after each release.

  • release-please-config.json: README.md, docs/how-to/add-falco-to-your-build.md and docs/reference/modules-and-coordinates.md join build.gradle.kts as generic extra-files. The release pull request now rewrites the marked snippets.
  • renovate.json: the existing regex customManager also reads /^docs/.+\.md$/, includes falco-migration, and gets a second match string for Maven <groupId>/<artifactId>/<version> entries. Gradle and Maven forms share one dependency name through depNameTemplate. This catches snippets without a marker (the tutorial, whose block also names Minestom) and the Maven snippets of docs: keep the how-to guides to their steps #102. The description array gets one sentence on the division of labour, and the manager's own description no longer points at the wiki.

Types of changes

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

Release and dependency automation only; no code changes.

Checklist

  • The title of this pull request is a Conventional Commit

Further comments

Checks:

  • npx renovate-config-validator renovate.json reports Config validated successfully against 1 file(s).
  • The two match strings, run in Python against README.md, the how-to page, the tutorial and the Maven snippets of docs: keep the how-to guides to their steps #102, find every Falco coordinate (bom, anvil, light, instance, migration) in both forms and nothing else; net.minestom:minestom and falco-demo are not matched.
  • Release Please: the real generic updater (release-please@latest) changes exactly the marked lines (see the previous PR for the counts). A line without a marker, the tutorial snippet, stays untouched.
  • A full Renovate dry run was not possible locally (the installed Node is rejected by Renovate), so the depNameTemplate handling of the first match string rests on the validator and the Python test, not on a Renovate extraction run. The first Renovate run after merge shows it.

Both tools can raise the same line. After a release the release pull request already carries the new number, so Renovate finds nothing left to bump there.

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 changed the base branch from docs/mark-falco-version to main October 10, 2026 19:29
@TheMeinerLP
TheMeinerLP force-pushed the chore/docs-version-automation branch from e385676 to 30e9a87 Compare October 10, 2026 19:30
@TheMeinerLP
TheMeinerLP merged commit 24ac3c5 into main Oct 10, 2026
4 checks passed
@TheMeinerLP
TheMeinerLP deleted the chore/docs-version-automation branch October 10, 2026 19:30
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