feat(filters): add note filter
#50
Merged
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
This reverts commit a1590faab7f1b4cc53db382c2fae8bf2a7651706.
Closed
shouya
added a commit
that referenced
this pull request
Feb 25, 2024
This filter allows you to add comments. Just insert a `note: <your comment>` line in the filter list. The `note` filter does not affect the pipeline in any way, although it does count as a filter in the `limit_filters` setting. Example: ```yaml - path: /foo.xml source: https://example.com/foo.xml note: This is the note for the endpoint filters: - full_text: {} - note: You can add a note filter to add comments to the pipeline. - merge: https://example.com/bar.xml - note: | This is a multiline note. It can be useful to add more detailed comments. ``` --------- An alternative approach I considered was to add a `note` field to all filters. However, this approach is limited because many filters are configured not as a struct. Often the case the config is just a single literal value, or a list of values. It would be inconsistent to add `note` field to those filters. I made an attempt in 2a38701, but reverted it due to the above reason. --------- Co-authored-by: shouya <shouya@users.noreply.github.com>
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.
This filter allows you to add comments. Just insert a
note: <your comment>line in the filter list.The
notefilter does not affect the pipeline in any way, although it does count as a filter in thelimit_filterssetting.Example:
An alternative approach I considered was to add a
notefield to all filters. However, this approach is limited because many filters are configured not as a struct. Often the case the config is just a single literal value, or a list of values. It would be inconsistent to addnotefield to those filters. I made an attempt in 2a38701, but reverted it due to the above reason.