From 0fbc80df992119377b1ae76f10c71fb2101983b7 Mon Sep 17 00:00:00 2001
From: Karel van Klink <karel.vanklink@geant.org>
Date: Thu, 3 Aug 2023 16:26:56 +0200
Subject: [PATCH] Adapt Vale config to be consistent with GSO
---
docs/vale/.vale.ini | 10 ++++++++++
lso/playbook.py | 4 +++-
2 files changed, 13 insertions(+), 1 deletion(-)
diff --git a/docs/vale/.vale.ini b/docs/vale/.vale.ini
index 0fbe065..6724b00 100644
--- a/docs/vale/.vale.ini
+++ b/docs/vale/.vale.ini
@@ -8,6 +8,16 @@ Packages = proselint, Microsoft
[*]
BasedOnStyles = Vale, proselint, Microsoft
+; Found to be too intrusive
+Microsoft.Passive = NO
+; We are not a general audience
+Microsoft.GeneralURL = NO
+; It's okay to leave TODOs in the code, that's what they're for
+proselint.Annotations = NO
+; Replacing a ... with … shouldn't be holding back the entire CI pipeline
+proselint.Typography = warning
+; Same applies for not using contractions
+Microsoft.Contractions = warning
[formats]
py = rst
diff --git a/lso/playbook.py b/lso/playbook.py
index 1f7e8b7..73fac95 100644
--- a/lso/playbook.py
+++ b/lso/playbook.py
@@ -122,7 +122,7 @@ def _run_playbook_proc(job_id: str, playbook_path: str, extra_vars: dict, invent
parsed_output.append(task_output["event_data"])
except json.JSONDecodeError:
- # If the line cannot be decoded as JSON, include it in its entirety.
+ # If the line can't be decoded as JSON, include it in its entirety.
parsed_output.append({"invalid_json": line})
payload = [
@@ -148,9 +148,11 @@ def run_playbook(playbook_path: str, extra_vars: dict, inventory: str, callback:
:param dict extra_vars: Any extra vars needed for the playbook to run.
:param [str] inventory: The inventory that the playbook is executed
against.
+
:param :class:`HttpUrl` callback: Callback URL where the playbook should send a status
update when execution is completed. This is used for
workflow-orchestrator to continue with the next step in a workflow.
+
:return: Result of playbook launch, this could either be successful or
unsuccessful.
:rtype: :class:`PlaybookLaunchResponse`
--
GitLab