apache / apache/maven-release

[MRELEASE-905] Provide better documentation on mavenExecutorId parameter

Open
#988 0 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
Java
Stars
128
Forks
145
Avg merge
7h 7m
Merged PRs (30d)
3

Description

**[Sergei S. Ivanov](https://issues.apache.org/jira/secure/ViewProfile.jspa?name=sergei_ivanov@mail.ru)** opened **[MRELEASE-905](https://issues.apache.org/jira/browse/MRELEASE-905?redirect=false)** and commented

`mavenExecutorId` mojo parameter is virtually undocumented and there is no mention of `forked-path` executor. Can you please update `mavenExecutorId` parameter javadoc to (a) list the available options and (b) explain the difference between `invoker` and `forked-path` executors. It would also be beneficial if there was a small FAQ or Usage section dedicated to this parameter.

---

**Affects:** 2.5.1

**Issue Links:**
- [MRELEASE-346](https://issues.apache.org/jira/browse/MRELEASE-346) Refactor MavenExecutor out into some shared component (e.g. Invoker)

1 votes, 3 watchers

Contributor guide

No contributing guide indexed for this repository

Research direction

Locate the mavenExecutorId mojo parameter javadoc and the existing Maven Release Plugin usage documentation. Document the available executor options, explain the difference between invoker and forked-path, and add a small FAQ or Usage section if the documentation structure supports it.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
build-system, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.