[JENKINS-43052] Warn in Pipeline build log if a deprecated extension is used #1639
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
…is used When extensions created for freestyle projects have a more general purpose replacement in Pipeline, the more general purpose Pipeline step is preferred. This method allows the deprecated extension to suggest the preferred alternative. When one of those extensions is used in a Pipeline, write a ***DEPRECATED** warning message to the build log so that the user can eventually remove the use of the deprecated extension from their Pipeline. The deprecated warning message in the build log does not alter any behavior, it only provides a message for the user. Suggest alternatives for those cases where a reasonable alternative exists. Tested by running a Pipeline job with one of the deprecated extensions and confirmed that the message was displayed as expected. Tested by running a freestyle job with the same extension and confirmed that no message was written to the build log.
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.
[JENKINS-43052] Warn in Pipeline build log if a deprecated extension is used
When extensions created for freestyle projects have a more general purpose replacement in Pipeline, the more general purpose Pipeline step is preferred. This method allows the deprecated extension to suggest the preferred alternative.
When one of those extensions is used in a Pipeline, write a *DEPRECATED warning message to the build log so that the user can eventually remove the use of the deprecated extension from their Pipeline.
The deprecated warning message in the build log does not alter any behavior, it only provides a message for the user.
Suggest alternatives for those cases where a reasonable alternative exists.
Testing done
Tested by running a Pipeline job with one of the deprecated extensions and confirmed that the message was displayed as expected.
Tested by running a freestyle job with the same extension and confirmed that no message was written to the build log.
Submitter checklist