Skip to content

docs(contributing): require Groovy 4.x for the JIRA bridge - #1097

Open
milamberspace wants to merge 1 commit into
apache:mainfrom
milamberspace:docs/groovy-4x-requirement
Open

docs(contributing): require Groovy 4.x for the JIRA bridge#1097
milamberspace wants to merge 1 commit into
apache:mainfrom
milamberspace:docs/groovy-4x-requirement

Conversation

@milamberspace

Copy link
Copy Markdown
Contributor

Summary

  • CONTRIBUTING.md told contributors to install Groovy 3.x or newer, but the JIRA bridge cannot run on 3.x — it requires Groovy 4.x. This bumps the stated minimum to 4.x.
  • Motivation: tools/jira/bridge.groovy line 4 uses @Grab('org.apache.groovy:groovy-json:4.0.21'). The org.apache.groovy group ID only exists from Groovy 4 onward (Groovy 3 published under org.codehaus.groovy), so the dependency does not resolve on a 3.x runtime.
  • This aligns CONTRIBUTING.md with tools/jira/README.md (lines 56, 81–83), which already states the 4.x requirement and the reason. The dashboard generator runs on 3.0+, but since both tools share the same install line, 4.x is the correct minimum to state.

Type of change

  • Documentation (docs/, README.md, CONTRIBUTING.md)

Test plan

  • prek run --all-files passes (markdownlint, lychee link check, typos, SPDX — all green on the commit)
  • Doc-only change; no code paths affected.

RFC-AI-0004 compliance

  • No principles touched (documentation-only change).

Linked issues

Closes #1096

Notes for reviewers (optional)

Scoped intentionally to the version bump only. A separate, unrelated Groovy scoping bug in bridge.groovy (top-level def config vars — TRACKER_URL, API_TOKEN, AUTH_SCHEME — are invisible to the cmd_* methods and raise MissingPropertyException) was noticed nearby and will be handled in its own issue/PR.

The JIRA bridge's @grab uses the org.apache.groovy group ID, which only
exists from Groovy 4 onward, so it cannot run on Groovy 3.x. Align the
install instruction in CONTRIBUTING.md with tools/jira/README.md.

Closes apache#1096

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

@dpol1 dpol1 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approving — the stated minimum was simply wrong, and the fix is grounded: the bridge cannot resolve its dependency on a 3.x runtime.

Verified against the tree

tools/jira/bridge.groovy line 4 grabs org.apache.groovy:groovy-json:4.0.21, and the org.apache.groovy group ID only exists from Groovy 4 onward — Groovy 3 published its modules under org.codehaus.groovy — so @Grab resolution fails outright on a 3.x runtime. tools/jira/README.md (lines 55–56, 81–83) already states the 4.x requirement and the group-ID reason; this brings CONTRIBUTING.md in line with it. A repo-wide grep confirms the changed line was the only remaining "Groovy 3.x" reference, so the sweep is complete.


This review was drafted by an AI-assisted tool and checked and
submitted by an Apache Magpie contributor — not a maintainer, so
a maintainer's review remains the authoritative next step. If
something feels off, please reply on the PR.

More on how Apache Magpie handles maintainer review:
CONTRIBUTING.md § Opening a pull request.

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.

docs: CONTRIBUTING.md states Groovy 3.x but the JIRA bridge requires Groovy 4.x

2 participants