chore: sort imports

chore: Don't check in generated files

chore: remove OUTPUT_TYPE env var

chore: rename uploaded files

.gitignore

@@ -163,3 +163,7 @@ tests/test_data/**/*analysis.json
 test-results.xml
 report.html
 result/
+
+# Generated Report Files
+protocols_and_analyses.md
+protocols_and_analyses.zip

action.yml

@@ -7,15 +7,7 @@ inputs:
     description: 'relative path in the repository of the root folder in which to search for to search for protocols'
     required: false
     default: 'protocols'
-  OUTPUT_TYPE:
-    type: choice
-    description: 'type of output the action generates'
-    required: false
-    default: 'none'
-    options:
-      - 'none'
-      - 'zip'
-      - 'markdown'
+    type: string
 runs:
   using: 'docker'
   # image: 'docker://ghcr.io/y3rsh/ot-analyze:main'

ot_analyze.py

@@ -12,7 +12,8 @@
 
 from write_failed_analysis import write_failed_analysis
 
-FILE_BASENAME = "protocols_and_analyses"
+ZIP_FILE_BASENAME = "protocols_and_analyses"
+MARKDOWN_FILE_BASENAME = "summary"
 
 SUCCESS_COLOR = "#7beb73"
 FAILURE_COLOR = "#eb7373"
@@ -210,7 +211,7 @@ def find_python_protocols(directory: Path) -> List[Path]:
 def create_zip(directory_path: Path):
     absolute_directory_path = directory_path.absolute()
     try:
-        archive_name = shutil.make_archive(FILE_BASENAME, 'zip', absolute_directory_path, absolute_directory_path)
+        archive_name = shutil.make_archive(ZIP_FILE_BASENAME, 'zip', absolute_directory_path, absolute_directory_path)
         print(f"Zipfile created and saved to: {absolute_directory_path / archive_name}")
 
     except Exception as e:
@@ -242,9 +243,9 @@ def generate_result(protocol_path: ProtocolPaths) -> str:
     markdown_content = MARKDOWN_TEMPLATE.format(
         results="\n".join([generate_result(protocol_path) for protocol_path in protocol_paths]),
     )
-    markdown_file_name = f"{FILE_BASENAME}.md"
+    markdown_file_name = f"{MARKDOWN_FILE_BASENAME}.md"
     absolute_directory_path = Path.cwd()
-    with open(FILE_BASENAME + ".md", "w") as file:
+    with open(markdown_file_name, "w") as file:
         file.write(markdown_content)
         print(f"Markdown file created and saved to: {absolute_directory_path / markdown_file_name}")
 

tests/test_analyze.py

@@ -1,7 +1,7 @@
 import json
 from pathlib import Path
 
-from ot_analyze import analyze, generate_analysis_path, ProtocolPaths
+from ot_analyze import ProtocolPaths, analyze, generate_analysis_path
 
 import test_data.data as td