chore: tweak cd to ignore release triggers on changes only within .gi…

…thub or docs folders
algorandfoundation · Feb 18, 2025 · f6f7217 · f6f7217
1 parent b4aedd4
commit f6f7217
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 12 deletions.
diff --git a/.github/workflows/cd.yaml b/.github/workflows/cd.yaml
@@ -4,6 +4,9 @@ on:
   push:
     branches:
       - main
+    paths-ignore:
+      - "docs/**"
+      - ".github/**"
   workflow_dispatch:
     inputs:
       production_release:

diff --git a/.github/workflows/check-python.yaml b/.github/workflows/check-python.yaml
@@ -48,7 +48,6 @@ jobs:
       - name: Check docstrings are up to date
         run: poetry run poe docstrings-check
 
-      TODO: Restore before prod release of v3
       - name: Check docs are up to date
         run: |
           poetry run poe docs-md-only

diff --git a/docs/markdown/autoapi/algokit_utils/applications/enums/index.md b/docs/markdown/autoapi/algokit_utils/applications/enums/index.md
@@ -9,7 +9,7 @@
 
 ## Module Contents
 
-### *class* algokit_utils.applications.enums.OnSchemaBreak(\*args, \*\*kwds)
+### *class* algokit_utils.applications.enums.OnSchemaBreak
 
 Bases: `enum.Enum`
 
@@ -27,7 +27,7 @@ Create a new Application and delete the old Application in a single transaction
 
 Create a new Application
 
-### *class* algokit_utils.applications.enums.OnUpdate(\*args, \*\*kwds)
+### *class* algokit_utils.applications.enums.OnUpdate
 
 Bases: `enum.Enum`
 
@@ -49,7 +49,7 @@ Create a new Application and delete the old Application in a single transaction
 
 Create a new application
 
-### *class* algokit_utils.applications.enums.OperationPerformed(\*args, \*\*kwds)
+### *class* algokit_utils.applications.enums.OperationPerformed
 
 Bases: `enum.Enum`
 

diff --git a/docs/markdown/autoapi/algokit_utils/protocols/typed_clients/index.md b/docs/markdown/autoapi/algokit_utils/protocols/typed_clients/index.md
@@ -23,9 +23,7 @@ class Proto(Protocol):
 ```
 
 Such classes are primarily used with static type checkers that recognize
-structural subtyping (static duck-typing).
-
-For example:
+structural subtyping (static duck-typing), for example:
 
 ```default
 class C:
@@ -44,7 +42,7 @@ only the presence of given attributes, ignoring their type signatures.
 Protocol classes can be generic, they are defined as:
 
 ```default
-class GenProto[T](Protocol):
+class GenProto(Protocol[T]):
     def meth(self) -> T:
         ...
 ```
@@ -68,9 +66,7 @@ class Proto(Protocol):
 ```
 
 Such classes are primarily used with static type checkers that recognize
-structural subtyping (static duck-typing).
-
-For example:
+structural subtyping (static duck-typing), for example:
 
 ```default
 class C:
@@ -89,7 +85,7 @@ only the presence of given attributes, ignoring their type signatures.
 Protocol classes can be generic, they are defined as:
 
 ```default
-class GenProto[T](Protocol):
+class GenProto(Protocol[T]):
     def meth(self) -> T:
         ...
 ```