From cd75dbcaabab9b568b73ba0a056f896140918dc8 Mon Sep 17 00:00:00 2001
From: Ken'ichiro Oyama <k1low@tailor.tech>
Date: Wed, 17 Sep 2025 19:27:27 +0900
Subject: [PATCH] feat: add support for configurable acceptable thresholds in
 octocov output

---
 README.md        | 56 +++++++++++++++++++++++++++++++++++++++++++++++-
 cmd/metrics.go   | 11 ++++++----
 config/config.go | 15 ++++++++++---
 3 files changed, 74 insertions(+), 8 deletions(-)

diff --git a/README.md b/README.md
index 5f9d544..4b9bdd4 100644
--- a/README.md
+++ b/README.md
@@ -79,7 +79,7 @@ export TAILOR_TOKEN=your_access_token
 patterner metrics
 ```
 
-The metrics command displays metrics in a table format. Use the `--out-octocov-path` option to output metrics in octocov custom metrics format.
+The metrics command displays metrics in a table format. Use the `--out-octocov-path` option to output metrics in octocov custom metrics format with configurable acceptable thresholds.
 
 #### Metrics Options
 
@@ -124,6 +124,43 @@ patterner metrics --out-octocov-path metrics.json
 patterner metrics --since 24hours --out-octocov-path metrics.json --with-coverage-full-report --with-lint-warnings
 ```
 
+#### Octocov Custom Metrics Format
+
+When using the `--out-octocov-path` option, patterner outputs metrics in octocov custom metrics format. This format includes:
+
+- **Metrics data** - All collected metrics with their values and units
+- **Acceptable thresholds** - Configurable conditions that define acceptable metric values
+  - Configured via `metrics.octocov.acceptables` in `.patterner.yml`
+  - Used by [octocov](https://github.com/k1LoW/octocov) to evaluate whether metrics meet quality standards
+
+**Example octocov output:**
+```json
+[
+  {
+    "key": "patterner-metrics",
+    "name": "Patterner Metrics",
+    "metrics": [
+      {
+        "key": "pipeline_resolver_step_coverage_percentage",
+        "name": "Pipeline Resolver Step Coverage",
+        "value": 75.0,
+        "unit": "%"
+      },
+      {
+        "key": "lint_warnings_total",
+        "name": "Lint Warnings Total",
+        "value": 3,
+        "unit": "count"
+      }
+    ],
+    "acceptables": [
+      "pipeline_resolver_step_coverage_percentage >= 80",
+      "lint_warnings_total <= 5"
+    ]
+  }
+]
+```
+
 **Implementation Notes:**
 ```
 <!-- Note: Current implementation has a typo in variable name 'lint_warnigns_total'
@@ -252,8 +289,25 @@ lint:
     stateflow:
       deprecatedFeature:
         enabled: true
+metrics:
+  octocov:
+    acceptables:
+      - "current.pipeline_resolver_step_coverage_percentage >= 80"
+      - "diff.lint_warnings_total <= 0"
 ```
 
+### Metrics Configuration
+
+#### Octocov Integration
+
+- **octocov** - Configuration for octocov custom metrics format output
+  - `acceptables` - List of acceptable threshold conditions for metrics
+    - Define minimum acceptable values for metrics in octocov format
+    - Used when outputting metrics with `--out-octocov-path` option
+    - Format: `"metric_name operator value"` (e.g., `"coverage_percentage >= 80"`)
+    - Supports various metrics including coverage percentages and lint warning counts
+    - Example: `["pipeline_resolver_step_coverage_percentage >= 80", "lint_warnings_total <= 5"]`
+
 ### Lint Configuration
 
 #### Acceptable Warnings
diff --git a/cmd/metrics.go b/cmd/metrics.go
index b0f43f4..04d18a9 100644
--- a/cmd/metrics.go
+++ b/cmd/metrics.go
@@ -188,6 +188,8 @@ var metricsCmd = &cobra.Command{
 					Unit:  m.Unit,
 				})
 			}
+			metricSet.Acceptables = append(metricSet.Acceptables, cfg.Metrics.Octocov.Acceptables...)
+
 			csets := []*CustomMetricSet{metricSet}
 			b, err := json.MarshalIndent(csets, "", "  ")
 			if err != nil {
@@ -219,10 +221,11 @@ type MetadataKV struct {
 }
 
 type CustomMetricSet struct {
-	Key      string          `json:"key"`
-	Name     string          `json:"name,omitempty"`
-	Metadata []*MetadataKV   `json:"metadata,omitempty"`
-	Metrics  []*CustomMetric `json:"metrics"`
+	Key         string          `json:"key"`
+	Name        string          `json:"name,omitempty"`
+	Metadata    []*MetadataKV   `json:"metadata,omitempty"`
+	Metrics     []*CustomMetric `json:"metrics"`
+	Acceptables []string        `json:"acceptables,omitempty"`
 }
 
 type CustomMetric struct {
diff --git a/config/config.go b/config/config.go
index 10c906b..afa4327 100644
--- a/config/config.go
+++ b/config/config.go
@@ -9,8 +9,9 @@ import (
 )
 
 type Config struct {
-	WorkspaceID string `default:"" yaml:"workspaceID,omitempty"`
-	Lint        Lint   `yaml:"lint,omitempty"`
+	WorkspaceID string  `default:"" yaml:"workspaceID,omitempty"`
+	Lint        Lint    `yaml:"lint,omitempty"`
+	Metrics     Metrics `yaml:"metrics,omitempty"`
 }
 
 type Lint struct {
@@ -27,7 +28,7 @@ type Rules struct {
 type Pipeline struct {
 	DeprecatedFeature     PipelineDeprecatedFeature `yaml:"deprecatedFeature,omitempty,omitzero"`
 	InsecureAuthorization InsecureAuthorization     `yaml:"insecureAuthorization,omitempty,omitzero"`
-	StepCount            StepCount                `yaml:"stepCount,omitempty,omitzero"`
+	StepCount             StepCount                 `yaml:"stepCount,omitempty,omitzero"`
 	MultipleMutations     MultipleMutations         `yaml:"multipleMutations,omitempty,omitzero"`
 	QueryBeforeMutation   QueryBeforeMutation       `yaml:"queryBeforeMutation,omitempty,omitzero"`
 }
@@ -76,6 +77,14 @@ type StateFlowDeprecatedFeature struct {
 	Enabled bool `default:"true" yaml:"enabled,omitempty"`
 }
 
+type Metrics struct {
+	Octocov Octocov `yaml:"octocov,omitempty,omitzero"`
+}
+
+type Octocov struct {
+	Acceptables []string `yaml:"acceptables,omitempty"`
+}
+
 const Filename = ".patterner.yml"
 
 func New() (*Config, error) {