Add ability to limit or exclude vcs file list whilst building payload #150
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.
This change includes the following new features:
default value is 100 files across all changes in a build.
NOTE: In the cases where the change list is disabled or too large (1 & 2
above), the payload will contain a
null
files list.This is preferable to returning an empty list, because the empty list
implies no actual changed files were included in the change.
A null change list will typically be serialised to nothing in JSON or
XML, so the json array or xml element will be missing from the payload.
If your endpoint is expecting these, then it should fail in this
scenario or handle the missing field gracefully.
Enables control over whether or not to include the list of files in a
change. This can be enabled in the three ways below, in order of
priority.
editing plugin-settings.xml
'webhook.includeChangeFileList'
'webhook.includeChangeFileList'.
The value must be a string representation of a boolean. eg, "true" or
anything else will evaluate to false.
Enables control over the maximum number of files changed in a build
before the changed file list is null. This can be controlled in the
three ways below, in order of priority.
editing plugin-settings.xml
'webhook.maxChangeFileListSize'
'webhook.maxChangeFileListSize'
If the total number of files is greater than
maxChangeFileListSize
,then the change list will be null. See note above.