You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by GitBox <gi...@apache.org> on 2022/05/12 10:39:26 UTC

[GitHub] [pulsar] yangl opened a new pull request, #15564: [doc] modify the `entry_filter.yaml` Nar filename to `entry_filter.yml`.

yangl opened a new pull request, #15564:
URL: https://github.com/apache/pulsar/pull/15564

   ### Motivation
   
   
   https://pulsar.apache.org/docs/next/develop-plugin 
   
   Describe a NAR file.
   
   Create an **entry_filter.yaml** file in the resources/META-INF/services directory to describe a NAR file. 
   
   the `entry_filter.yaml` should `entry_filter.yml` 
   
   ```java
       static final String ENTRY_FILTER_DEFINITION_FILE = "entry_filter.yml";
   ```
   https://github.com/apache/pulsar/blob/master/pulsar-broker/src/main/java/org/apache/pulsar/broker/service/plugin/EntryFilterProvider.java#L39
   
   
   addition, i write a plugin for the broker side msg filter by this doc, thanks @315157973 
   
   https://github.com/yangl/pulsar-msg-filter-plugin
   
   ### Modifications
   
   fix the error description `entry_filter.yaml` to `entry_filter.yml` .
   
   
   ### Verifying this change
   
   - [ ] Make sure that the change passes the CI checks.
   
   *(Please pick either of the following options)*
   
   This change is a trivial rework / code cleanup without any test coverage.
   
   *(or)*
   
   This change is already covered by existing tests, such as *(please describe tests)*.
   
   *(or)*
   
   This change added tests and can be verified as follows:
   
   *(example:)*
     - *Added integration tests for end-to-end deployment with large payloads (10MB)*
     - *Extended integration test for recovery after broker failure*
   
   ### Does this pull request potentially affect one of the following parts:
   
   *If `yes` was chosen, please highlight the changes*
   
     - Dependencies (does it add or upgrade a dependency): (yes / no)
     - The public API: (yes / no)
     - The schema: (yes / no / don't know)
     - The default values of configurations: (yes / no)
     - The wire protocol: (yes / no)
     - The rest endpoints: (yes / no)
     - The admin cli options: (yes / no)
     - Anything that affects deployment: (yes / no / don't know)
   
   ### Documentation
   
   Check the box below or label this PR directly.
   
   Need to update docs? 
   
   - [ ] `doc-required` 
   (Your PR needs to update docs and you will update later)
     
   - [ ] `no-need-doc` 
   (Please explain why)
     
   - [x] `doc` 
   (Your PR contains doc changes)
   
   - [ ] `doc-added`
   (Docs have been already added)


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [pulsar] yangl commented on a diff in pull request #15564: [doc] modify the `entry_filter.yaml` Nar filename to `entry_filter.yml`.

Posted by GitBox <gi...@apache.org>.
yangl commented on code in PR #15564:
URL: https://github.com/apache/pulsar/pull/15564#discussion_r871941212


##########
site2/docs/develop-plugin.md:
##########
@@ -57,7 +57,7 @@ For how to create a Maven project, see [here](https://maven.apache.org/guides/ge
 
 3. Describe a NAR file.
 
-    Create an `entry_filter.yaml` file in the `resources/META-INF/services` directory to describe a NAR file.
+    Create an `entry_filter.yml` file in the `resources/META-INF/services` directory to describe a NAR file.

Review Comment:
   [The YAML spec](https://yaml.org/spec/1.2.2/) not special the file name extensions with .yml or .yaml, but in the spring-project community most use the `.yml`.
   
   And no difference  between the `.yml` and `.yaml`
   https://stackoverflow.com/questions/22268952/what-is-the-difference-between-yaml-and-yml-extension
   
   https://en.wikipedia.org/wiki/YAML
   
   in addition, if we change the code to `entry_filter.yaml`, we have to consider compatibility issues.



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [pulsar] codelipenghui merged pull request #15564: [doc] modify the `entry_filter.yaml` Nar filename to `entry_filter.yml`.

Posted by GitBox <gi...@apache.org>.
codelipenghui merged PR #15564:
URL: https://github.com/apache/pulsar/pull/15564


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [pulsar] 315157973 commented on a diff in pull request #15564: [doc] modify the `entry_filter.yaml` Nar filename to `entry_filter.yml`.

Posted by GitBox <gi...@apache.org>.
315157973 commented on code in PR #15564:
URL: https://github.com/apache/pulsar/pull/15564#discussion_r871351064


##########
site2/docs/develop-plugin.md:
##########
@@ -57,7 +57,7 @@ For how to create a Maven project, see [here](https://maven.apache.org/guides/ge
 
 3. Describe a NAR file.
 
-    Create an `entry_filter.yaml` file in the `resources/META-INF/services` directory to describe a NAR file.
+    Create an `entry_filter.yml` file in the `resources/META-INF/services` directory to describe a NAR file.

Review Comment:
   It looks like a typo. I think we should fix the code.



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org