ToolMetadata.rule_url should be optional; expose via API (#380)

drdavella · drdavella · commit b00f180cc29f · 2024-03-14T13:25:28.000-04:00
* ToolMetadata.rule_url should be optional; expose via API

* Run test workflow on release branches
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -5,12 +5,14 @@ on:
     branches:
       - main
       - develop
+      - "[0-9]+.[0-9]+.x"
     tags:
       - "[0-9]+.[0-9]+.[0-9]+"
   pull_request:
     branches:
       - main
       - develop
+      - "[0-9]+.[0-9]+.x"
   merge_group:
 
 concurrency:
diff --git a/src/codemodder/codemods/api.py b/src/codemodder/codemods/api.py
@@ -8,6 +8,7 @@
     Metadata,
     Reference,
     ReviewGuidance,
+    ToolMetadata,
 )
 from codemodder.codemods.libcst_transformer import (
     LibcstResultTransformer,
diff --git a/src/codemodder/codemods/base_codemod.py b/src/codemodder/codemods/base_codemod.py
@@ -41,7 +41,7 @@ class ToolMetadata:
     name: str
     rule_id: str
     rule_name: str
-    rule_url: str
+    rule_url: str | None = None
 
 
 class BaseCodemod(metaclass=ABCMeta):

Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,7 @@`
`8`	`8`	`Metadata,`
`9`	`9`	`Reference,`
`10`	`10`	`ReviewGuidance,`
	`11`	`+ ToolMetadata,`
`11`	`12`	`)`
`12`	`13`	`from codemodder.codemods.libcst_transformer import (`
`13`	`14`	`LibcstResultTransformer,`