Add yamllint during PRs (#4)

* run yamllint on PRs
lightstep · Feb 27, 2024 · c5a22ef · c5a22ef
1 parent c7f3900
commit c5a22ef
Show file tree

Hide file tree

Showing 12 changed files with 91 additions and 65 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -4,7 +4,8 @@
 name: Build
 on:
   pull_request:
-
+    paths:
+      - collector/**
 jobs:
   build_linux:
     runs-on: ubuntu-20.04

diff --git a/.github/workflows/checks.yml b/.github/workflows/checks.yml
@@ -0,0 +1,14 @@
+name: pr_checks
+on:
+  pull_request:
+
+jobs:
+  yamllint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: yaml-lint
+        uses: ibiqlik/action-yamllint@v3
+        with:
+          file_or_dir: collector/config/*.yaml collector/config-k8s/*.yaml
+          config_file: .yamllint.yml
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -1,6 +1,8 @@
 name: Tests
 on:
   pull_request:
+    paths:
+      - collector/**
 
 jobs:
   unit-tests:

diff --git a/.yamllint.yml b/.yamllint.yml
@@ -0,0 +1,6 @@
+extends: default
+
+rules:
+  line-length:
+    max: 80
+    level: warning
diff --git a/collector/Makefile b/collector/Makefile
@@ -1,3 +1,6 @@
+ALLDOC := $(shell find .. \( -name "*.md" -o -name "*.yaml" \) \
+                                -type f | sort)
+
 .PHONY: all - Default target
 all: build
 

diff --git a/collector/config-k8s/values-cluster.yaml b/collector/config-k8s/values-cluster.yaml
@@ -36,7 +36,7 @@ config:
       collection_interval: 30s
     jaeger: null
     zipkin: null
-  
+
   processors:
     resourcedetection/gcp:
       detectors: [env, gcp]
@@ -92,9 +92,9 @@ config:
       headers:
         "lightstep-access-token": "${env:CLOUDOBS_TOKEN}"
       sending_queue:
-          enabled: true
-          num_consumers: 4
-          queue_size: 100
+        enabled: true
+        num_consumers: 4
+        queue_size: 100
 
   service:
     # This isn't the final pipeline configuration: the helm chart values
@@ -104,14 +104,14 @@ config:
       traces: null
       # Send metrics about the collector itself to Cloud Observability
       metrics/collector-monitoring:
-        receivers: [ prometheus ]
-        processors: [ batch ]
-        exporters: [ otlp/cloudobs ]
+        receivers: [prometheus]
+        processors: [batch]
+        exporters: [otlp/cloudobs]
       metrics:
-        exporters: [ otlp/cloudobs ]
+        exporters: [otlp/cloudobs]
       logs:
-        processors: [ transform/events, batch ]
-        exporters: [ otlp/cloudobs ]
+        processors: [transform/events, batch]
+        exporters: [otlp/cloudobs]
 
 ports:
   jaeger-compact:

diff --git a/collector/config-k8s/values-node.yaml b/collector/config-k8s/values-node.yaml
@@ -87,9 +87,9 @@ config:
       headers:
         "lightstep-access-token": "${env:CLOUDOBS_TOKEN}"
       sending_queue:
-          enabled: true
-          num_consumers: 4
-          queue_size: 100
+        enabled: true
+        num_consumers: 4
+        queue_size: 100
 
   service:
     # This isn't the final pipeline configuration: the helm chart values

diff --git a/collector/config/otelcol-docker-hostmetrics.yaml b/collector/config/otelcol-docker-hostmetrics.yaml
@@ -9,10 +9,10 @@ receivers:
         - job_name: otel-collector
           scrape_interval: 5s
           static_configs:
-          - labels:
-              collector_name: sn-collector
-            targets:
-              - 0.0.0.0:8888
+            - labels:
+                collector_name: sn-collector
+              targets:
+                - 0.0.0.0:8888
   hostmetrics:
     # needed to read host metrics from Docker cntainer
     # host path ostmust be mounted to the container
@@ -78,11 +78,11 @@ exporters:
   otlp/lightstep:
     endpoint: ingest.lightstep.com:443
     headers:
-      'lightstep-access-token': '${LS_TOKEN}'
+      "lightstep-access-token": "${LS_TOKEN}"
     sending_queue:
-        enabled: true
-        num_consumers: 4
-        queue_size: 100
+      enabled: true
+      num_consumers: 4
+      queue_size: 100
   # Send to HLA
   servicenow/logs:
     instance_logs_url: ${MID_INSTANCE_LOGS_URL}
@@ -119,6 +119,6 @@ service:
       processors: [batch, resourcedetection]
       exporters: [debug]
     metrics/host:
-       receivers: [hostmetrics]
-       processors: [batch, resourcedetection]
-       exporters: [debug]
+      receivers: [hostmetrics]
+      processors: [batch, resourcedetection]
+      exporters: [debug]
diff --git a/collector/config/otelcol-linux-hostmetrics.yaml b/collector/config/otelcol-linux-hostmetrics.yaml
@@ -9,10 +9,10 @@ receivers:
         - job_name: otel-collector
           scrape_interval: 5s
           static_configs:
-          - labels:
-              collector_name: sn-collector
-            targets:
-              - 0.0.0.0:8888
+            - labels:
+                collector_name: sn-collector
+              targets:
+                - 0.0.0.0:8888
   hostmetrics:
     collection_interval: 5s
     scrapers:
@@ -36,11 +36,11 @@ exporters:
   otlp/lightstep:
     endpoint: ingest.lightstep.com:443
     headers:
-      'lightstep-access-token': '${LS_TOKEN}'
+      "lightstep-access-token": "${LS_TOKEN}"
     sending_queue:
-        enabled: true
-        num_consumers: 4
-        queue_size: 100
+      enabled: true
+      num_consumers: 4
+      queue_size: 100
   # Send to HLA
   servicenow/logs:
     instance_logs_url: ${MID_INSTANCE_LOGS_URL}
@@ -68,14 +68,14 @@ extensions:
       ws:
         endpoint: https://opamp.lightstep.com/v1/opamp
       headers:
-          "Authorization": "Bearer ${LS_OPAMP_API_KEY}"
+        "Authorization": "Bearer ${LS_OPAMP_API_KEY}"
 service:
   pipelines:
     metrics/collector:
       receivers: [prometheus/self]
       processors: [batch, resourcedetection]
       exporters: [debug]
     metrics/host:
-       receivers: [hostmetrics]
-       processors: [batch, resourcedetection]
-       exporters: [debug]
+      receivers: [hostmetrics]
+      processors: [batch, resourcedetection]
+      exporters: [debug]
diff --git a/collector/config/otelcol-macos-hostmetrics.yaml b/collector/config/otelcol-macos-hostmetrics.yaml
@@ -1,4 +1,4 @@
-# 
+#
 # Basic OpenTelemetry host metrics for macOS.
 # Validated with v0.95.0 on 2/21/24
 #
@@ -9,10 +9,10 @@ receivers:
         - job_name: otel-collector
           scrape_interval: 5s
           static_configs:
-          - labels:
-              collector_name: sn-collector
-            targets:
-              - 0.0.0.0:8888
+            - labels:
+                collector_name: sn-collector
+              targets:
+                - 0.0.0.0:8888
   hostmetrics:
     collection_interval: 5s
     # cpu and disk not supported by macOS
@@ -35,11 +35,11 @@ exporters:
   otlp/lightstep:
     endpoint: ingest.lightstep.com:443
     headers:
-      'lightstep-access-token': '${LS_TOKEN}'
+      "lightstep-access-token": "${LS_TOKEN}"
     sending_queue:
-        enabled: true
-        num_consumers: 4
-        queue_size: 100
+      enabled: true
+      num_consumers: 4
+      queue_size: 100
   # Send to HLA
   servicenow/logs:
     instance_logs_url: ${MID_INSTANCE_LOGS_URL}
@@ -76,6 +76,6 @@ service:
       processors: [batch, resourcedetection]
       exporters: [debug]
     metrics/host:
-       receivers: [hostmetrics]
-       processors: [batch, resourcedetection]
-       exporters: [debug]
+      receivers: [hostmetrics]
+      processors: [batch, resourcedetection]
+      exporters: [debug]
diff --git a/collector/config/otelcol-windows-hostmetrics.yaml b/collector/config/otelcol-windows-hostmetrics.yaml
@@ -9,10 +9,10 @@ receivers:
         - job_name: otel-collector
           scrape_interval: 5s
           static_configs:
-          - labels:
-              collector_name: sn-collector
-            targets:
-              - 0.0.0.0:8888
+            - labels:
+                collector_name: sn-collector
+              targets:
+                - 0.0.0.0:8888
   hostmetrics:
     collection_interval: 5s
     scrapers:
@@ -36,11 +36,11 @@ exporters:
   otlp/lightstep:
     endpoint: ingest.lightstep.com:443
     headers:
-      'lightstep-access-token': '${LS_TOKEN}'
+      "lightstep-access-token": "${LS_TOKEN}"
     sending_queue:
-        enabled: true
-        num_consumers: 4
-        queue_size: 100
+      enabled: true
+      num_consumers: 4
+      queue_size: 100
   # Send to HLA
   servicenow/logs:
     instance_logs_url: ${MID_INSTANCE_LOGS_URL}
@@ -68,14 +68,14 @@ extensions:
       ws:
         endpoint: https://opamp.lightstep.com/v1/opamp
       headers:
-          "Authorization": "Bearer ${LS_OPAMP_API_KEY}"
+        "Authorization": "Bearer ${LS_OPAMP_API_KEY}"
 service:
   pipelines:
     metrics/collector:
       receivers: [prometheus/self]
       processors: [batch, resourcedetection]
       exporters: [debug]
     metrics/host:
-       receivers: [hostmetrics]
-       processors: [batch, resourcedetection]
-       exporters: [debug]
+      receivers: [hostmetrics]
+      processors: [batch, resourcedetection]
+      exporters: [debug]
diff --git a/docs/development.md b/docs/development.md
@@ -21,10 +21,10 @@ make
 goreleaser release --snapshot --rm-dist
 ```
 
-To build for multiple platforms, this repository runs goreleaser automatically in a Github Action when a tag starting with `v` is pushed to the repository.
+To build for multiple platforms, this repository runs goreleaser automatically in a Github Action when a tag starting with `v` is pushed to the repossitory.
 
 ```sh
-    git tag v0.0.1
-    git push origin --tags
-    # ... Github Action to build and released kicked off remotely
+git tag v0.0.1
+git push origin --tags
+# ... Github Action to build and released kicked off remotely
 ```