Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use yaml node tags to enforce NUMAFLOW_DEBUG string type #1742

Closed
th0ger opened this issue May 28, 2024 · 0 comments
Closed

Use yaml node tags to enforce NUMAFLOW_DEBUG string type #1742

th0ger opened this issue May 28, 2024 · 0 comments
Labels
good first issue Good for new contributors help wanted Contributions welcome
Milestone

Comments

@th0ger
Copy link
Contributor

th0ger commented May 28, 2024

The repos are full of the following verbose templates:

containerTemplate:
  env:
    - name: NUMAFLOW_DEBUG
      value: "true" # DO NOT forget the double quotes!!!

Instead of the verbose comments, I suggest to use YAML node tags

      value: !!str "true"

This would also make the following valid:

      value: !!str true

Coverage:

$ grep -Rnw . -e 'value:[[:space:]]"true"'
./numaflow-go/pkg/sideinput/examples/simple_sideinput/README.md:69:            value: "true" # DO NOT forget the double quotes!!!
./numaflow-go/pkg/sideinput/examples/simple_sideinput/pipeline.yaml:29:            value: "true" # DO NOT forget the double quotes!!!
./numaflow-go/pkg/sideinput/examples/sideinput_function/README.md:71:            value: "true" # DO NOT forget the double quotes!!!
./numaflow/examples/7-reduce-sliding-window.yaml:13:            value: "true" # DO NOT forget the double quotes!!!
./numaflow/examples/7-reduce-sliding-window.yaml:20:            value: "true" # DO NOT forget the double quotes!!!
./numaflow/examples/7-reduce-sliding-window.yaml:47:            value: "true" # DO NOT forget the double quotes!!!
./numaflow/docs/development/debugging.md:24:            value: "true" # DO NOT forget the double quotes!!!
./numaflow/docs/development/debugging.md:49:            value: "true" # DO NOT forget the double quotes!!!
./numaflow/config/apps/redis/redis-minimal.yaml:69:              value: "true"
./numaflow/config/apps/kafka/kafka-minimal.yaml:83:              value: "true"
./numaflow/config/apps/kafka/kafka-minimal.yaml:85:              value: "true"
./numaflow/test/manifests/kustomization.yaml:22:          value: "true"
./numaflow/test/e2e/testdata/watermark.yaml:18:            value: "true" # DO NOT forget the double quotes!!!
./numaflow/test/e2e/testdata/watermark.yaml:27:            value: "true" # DO NOT forget the double quotes!!!
./numaflow/test/e2e/testdata/watermark.yaml:35:            value: "true" # DO NOT forget the double quotes!!!
./numaflow/test/e2e/testdata/watermark.yaml:44:            value: "true" # DO NOT forget the double quotes!!!
./numaflow-python/examples/sideinput/simple-sideinput/pipeline.yaml:29:            value: "true" # DO NOT forget the double quotes!!!
./numaflow-python/examples/sink/async_log/pipeline.yaml:28:                value: "true"
./numaflow-python/examples/sink/log/pipeline.yaml:28:                value: "true"
./numaflow-python/examples/reduce/counter/pipeline.yaml:25:              value: "true"
./numaflow-python/examples/map/flatmap/pipeline.yaml:21:              value: "true"
./numaflow-python/examples/map/flatmap/pipeline.yaml:32:            value: "true" # DO NOT forget the double quotes!!!
./numaflow-python/examples/map/multiproc_map/pipeline.yaml:21:              value: "true"
./numaflow-python/examples/map/multiproc_map/pipeline.yaml:34:            value: "true" # DO NOT forget the double quotes!!!
./numaflow-python/examples/mapstream/flatmap_stream/pipeline.yaml:27:              value: "true"
./numaflow-python/examples/mapstream/flatmap_stream/pipeline.yaml:40:            value: "true" # DO NOT forget the double quotes!!!
./numaflow-python/examples/reducestream/counter/pipeline.yaml:25:              value: "true"
./numaflow-python/examples/reducestream/sum/pipeline.yaml:25:              value: "true"

Message from the maintainers:

If you wish to see this enhancement implemented please add a 👍 reaction to this issue! We often sort issues this way to know what to prioritize.

@th0ger th0ger added the enhancement New feature or request label May 28, 2024
@vigith vigith added good first issue Good for new contributors help wanted Contributions welcome and removed enhancement New feature or request labels May 28, 2024
charans29 added a commit to charans29/numaflow that referenced this issue Jun 1, 2024
charans29 added a commit to charans29/numaflow that referenced this issue Jun 1, 2024
charans29 added a commit to charans29/numaflow that referenced this issue Jun 4, 2024
charans29 added a commit to charans29/numaflow that referenced this issue Jun 4, 2024
charans29 added a commit to charans29/numaflow that referenced this issue Jun 4, 2024
charans29 added a commit to charans29/numaflow that referenced this issue Jun 4, 2024
charans29 added a commit to charans29/numaflow that referenced this issue Jun 4, 2024
charans29 added a commit to charans29/numaflow that referenced this issue Jun 4, 2024
@whynowy whynowy closed this as completed in b26008e Jun 5, 2024
@vigith vigith added this to the 1.3 milestone Jul 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for new contributors help wanted Contributions welcome
Projects
None yet
Development

No branches or pull requests

2 participants