Allow exiting with 0 regardless of flake8 status.

Author: domdfcoding

flake8_github_action/__init__.py

@@ -99,6 +99,11 @@ def action(
 
 	# check_run_id = check.create_check_run()
 	check_run_id = check.find_run_for_action()
+	check.update_check_run(
+			check_run_id,
+			status="in_progress",
+			output={"title": "Flake8 checks", "summary": "Output from Flake8"},
+			)
 
 	flake8_app = Application()
 	flake8_app.run(args)
@@ -110,32 +115,34 @@ def action(
 	for filename, raw_annotations in json_annotations:
 		annotations.extend(Annotation.from_flake8json(filename, ann) for ann in raw_annotations)
 
-	# Github limits updates to 50 annotations at a time
-	annotation_chunks = list(chunks(annotations, 50))
-
-	if flake8_app.result_count:
-		conclusion = "failure"
-		ret = 1
-	else:
-		conclusion = "success"
-		ret = 0
-
-	for chunk in annotation_chunks[:-1]:
-		check.update_check_run(
-				check_run_id,
-				conclusion=conclusion,
-				output={
-						"title": "Flake8 checks",
-						"summary": "Output from Flake8",
-						"annotations": [a.to_dict() for a in chunk],
-						},
-				)
-
-	output = {
-			"title": "Flake8 checks",
-			"summary": "Output from Flake8",
-			"annotations": [a.to_dict() for a in annotation_chunks[-1]],
-			}
-
-	# TODO: reflect flake8 output
-	return check.complete_check_run(check_run_id, conclusion="success", output=output), ret
+	if annotations:
+		# Github limits updates to 50 annotations at a time
+		annotation_chunks = list(chunks(annotations, 50))
+
+		if flake8_app.result_count:
+			conclusion = "failure"
+			ret = 1
+		else:
+			conclusion = "success"
+			ret = 0
+
+		for chunk in annotation_chunks[:-1]:
+			check.update_check_run(
+					check_run_id,
+					conclusion=conclusion,
+					output={
+							"title": "Flake8 checks",
+							"summary": "Output from Flake8",
+							"annotations": [a.to_dict() for a in chunk],
+							},
+					)
+
+		output = {
+				"title": "Flake8 checks",
+				"summary": "Output from Flake8",
+				"annotations": [a.to_dict() for a in annotation_chunks[-1]],
+				}
+
+		return check.complete_check_run(check_run_id, conclusion=conclusion, output=output), ret
+
+	return check.complete_check_run(check_run_id, conclusion="success"), 0

flake8_github_action/__main__.py

@@ -60,9 +60,15 @@
 		default=None,
 		help="The repository name (in the format <username>/<repository>) or the complete GitHub URL.",
 		)
+@click.option(
+		"--annotate-only",
+		is_flag=True,
+		default=False,
+		help="Only add the annotations (exit 0 regardless of flake8 output).",
+		)
 @click.command(context_settings={"ignore_unknown_options": True, "allow_extra_args": True, **CONTEXT_SETTINGS})
 @click.pass_context
-def main(ctx: click.Context, token: str, repo: Union[str, URL, None] = None):
+def main(ctx: click.Context, token: str, repo: Union[str, URL, None] = None, annotate_only: bool = False,):
 	"""
 	Run flake8 and add the errors as annotations on GitHub.
 	"""
@@ -74,7 +80,11 @@ def main(ctx: click.Context, token: str, repo: Union[str, URL, None] = None):
 
 	# if response.status_code == 200:
 	# 	sys.exit(0)
-	sys.exit(ret)
+
+	if annotate_only:
+		sys.exit(0)
+	else:
+		sys.exit(ret)
 
 
 if __name__ == "__main__":