Terminology: Clean up X-to-Y-Callables #5494
Closed
Conversation
This file contains 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
daniel-beck
commented
May 16, 2021
| @@ -1117,8 +1117,8 @@ public void copyFrom(FileItem file) throws IOException, InterruptedException { | |||
| * <strong>Warning:</strong> implementations must be serializable, so prefer a static nested class to an inner class. | |||
| * | |||
| * <p> | |||
| * Subtypes would likely want to extend from either {@link MasterToSlaveCallable} | |||
| * or {@link SlaveToMasterFileCallable}. | |||
| * Subtypes would likely want to extend from either {@link jenkins.ControllerToAgentFileCallable} | |||
There was a problem hiding this comment.
I think this was wrong before, since this discusses FileCallables.
daniel-beck
commented
May 16, 2021
|
|
||
| /** | ||
| * Convenient {@link Callable} that are meant to run on the controller (sent by agent/CLI/etc). | ||
| * Note that any serializable fields must either be defined in your plugin or included in the stock JEP-200 whitelist. |
There was a problem hiding this comment.
I consider cleanup of this term in comments out of scope for this PR.
jvz
approved these changes
May 16, 2021
Wadeck
approved these changes
May 18, 2021
Comment on lines
4
to
+5
| * @since 1.587 / 1.580.1 | ||
| * @param <T> the return type; note that this must either be defined in your plugin or included in the stock JEP-200 whitelist | ||
| * @deprecated Use {@link ControllerToAgentFileCallable} |
There was a problem hiding this comment.
Do we want to add something like:
@since 1.587 / 1.580.1, deprecated since TODO
?
(mimic the @Deprecated(since = xxx) from Java 9)
oleg-nenashev
approved these changes
May 21, 2021
|
We may merge it in 24 hours if there is no negative feedback. Please see the merge process documentation for more information about the merge process |
oleg-nenashev
added
the
ready-for-merge
daniel-beck
added
on-hold
|
On-holding, makes no sense to merge before the one with the labels. |
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.
Related to #5425. I'm submitting this in a separate PR because I expect potential issues in review and don't think this should end up blocking the other PR.
This cleans up callable class names involved in the agent-to-controller security subsystem.
Existing types are retained as subclasses of the new ones (similar to
Hudson extends Jenkins), but deprecated.Proposed changelog entries
SlaveToMaster[File]Callable,MasterToSlave[File]Callable,Role.MASTERandRole.SLAVEin favor of the newAgentToController[File]Callable,ControllerToAgent[File]Callable,Role.CONTROLLERandRole.AGENT.Proposed upgrade guidelines
N/A
Submitter checklist
Proposed changelog entriessection only if there are breaking changes or other changes which may require extra steps from users during the upgradeDesired reviewers
@mention
Maintainer checklist
Before the changes are marked as
ready-for-merge:Proposed changelog entriesare correctupgrade-guide-neededlabel is set and there is aProposed upgrade guidelinessection in the PR title. (example)lts-candidateto be considered (see query).