diff --git a/.github/scripts/build_assets/arg_getters.py b/.github/scripts/build_assets/arg_getters.py index afff14f0..51c5d557 100644 --- a/.github/scripts/build_assets/arg_getters.py +++ b/.github/scripts/build_assets/arg_getters.py @@ -45,8 +45,12 @@ def get_check_svgs_on_pr_args(): Get the commandline arguments for the check_svgs_on_pr.py. """ parser = ArgumentParser(description="Check the SVGs to ensure their attributes are correct. Run whenever a PR is opened") - parser.add_argument("files_changed_json_path", - help="The path to the files.json created by the gh-action-get-changed-files@2.1.4", + parser.add_argument("files_added_json_path", + help="The path to the files_added.json created by the gh-action-get-changed-files@2.1.4", + action=PathResolverAction) + + parser.add_argument("files_modified_json_path", + help="The path to the files_modified.json created by the gh-action-get-changed-files@2.1.4", action=PathResolverAction) return parser.parse_args() diff --git a/.github/scripts/build_assets/filehandler.py b/.github/scripts/build_assets/filehandler.py index fb918019..3cfe2c75 100644 --- a/.github/scripts/build_assets/filehandler.py +++ b/.github/scripts/build_assets/filehandler.py @@ -207,23 +207,26 @@ def create_screenshot_folder(dir, screenshot_name: str="screenshots/"): finally: return str(screenshot_folder) -def get_added_modified_svgs(files_changed_json_path: str): +def get_added_modified_svgs(files_added_json_path: str, + files_modified_json_path: str): """ Get the svgs added and modified from the files_changed_json_path. - :param: the path to the files.json created by the gh-action-get-changed-files@2.1.4 - :return: a list of the svg file paths that were added/modified in this pr. + :param: files_added_json_path, the path to the files_added.json created by the gh-action-get-changed-files@2.1.4 + :param: files_modified_json_path, the path to the files_modified.json created by the gh-action-get-changed-files@2.1.4 + :return: a list of the svg file paths that were added/modified in this pr as Path. """ - files_dict = get_json_file_content(files_changed_json_path) - print(files_dict) - svgs = [] - for file in files_dict["added"]: - path = Path(file) - if path.suffix.lower() == ".svg": - svgs.append(file) + files_added = get_json_file_content(files_added_json_path) + files_modified = get_json_file_content(files_modified_json_path) - for file in files_dict["modified"]: + svgs = [] + for file in files_added: path = Path(file) if path.suffix.lower() == ".svg": - svgs.append(file) + svgs.append(path) + + for file in files_modified: + path = Path(file) + if path.suffix.lower() == ".svg": + svgs.append(path) return svgs diff --git a/.github/scripts/build_assets/util.py b/.github/scripts/build_assets/util.py index 49f71ef9..68ea98bd 100644 --- a/.github/scripts/build_assets/util.py +++ b/.github/scripts/build_assets/util.py @@ -13,7 +13,7 @@ def exit_with_err(err: Exception): :param: err, the error/exception encountered. """ traceback.print_exc() - sys.exit(str(err)) + sys.exit(1) def check_svgs(svg_file_paths: List[Path]): diff --git a/.github/scripts/check_svgs_monthly.py b/.github/scripts/check_svgs_monthly.py index 10a65754..440e2fcb 100644 --- a/.github/scripts/check_svgs_monthly.py +++ b/.github/scripts/check_svgs_monthly.py @@ -22,6 +22,5 @@ def main(): util.exit_with_err(e) - if __name__ == "__main__": main() \ No newline at end of file diff --git a/.github/scripts/check_svgs_on_pr.py b/.github/scripts/check_svgs_on_pr.py index 67472fd7..3516219e 100644 --- a/.github/scripts/check_svgs_on_pr.py +++ b/.github/scripts/check_svgs_on_pr.py @@ -17,8 +17,10 @@ def main(): args = arg_getters.get_check_svgs_on_pr_args() try: # check the svgs - svgs = filehandler.get_added_modified_svgs(args.files_changed_json_path) + svgs = filehandler.get_added_modified_svgs(args.files_added_json_path, + args.files_modified_json_path) print("SVGs to check: ", *svgs, sep='\n') + util.check_svgs(svgs) print("All SVGs found were good. Task completed.") except Exception as e: diff --git a/.github/workflows/check_svgs_on_pr.yml b/.github/workflows/check_svgs_on_pr.yml index 5058eeea..a1a93c61 100644 --- a/.github/workflows/check_svgs_on_pr.yml +++ b/.github/workflows/check_svgs_on_pr.yml @@ -26,7 +26,7 @@ jobs: - name: Run the check_svg script shell: bash run: > - python ./.github/scripts/check_svgs_on_pr.py $HOME/files.json + python ./.github/scripts/check_svgs_on_pr.py $HOME/files_added.json $HOME/files_modified.json - name: Comment on the PR about the result - Success if: success() uses: github-actions-up-and-running/pr-comment@v1.0.1