new icon: testingicon (original, plain)

.github/scripts/build_assets/api_handler.py

@@ -1,8 +1,14 @@
 import requests
 import sys
 import re
+from typing import List
 
 
+# our base url which leads to devicon
+# base_url = "https://api.github.com/repos/devicons/devicon/"
+# testing url
+base_url = "https://api.github.com/repos/Thomas-Boi/devicon/" 
+
 def get_merged_pull_reqs_since_last_release(token):
     """
     Get all the merged pull requests since the last release.
@@ -38,7 +44,7 @@ def get_merged_pull_reqs(token, page):
     :param token, a GitHub API token.
     :param page, the page number.
     """
-    queryPath = "https://api.github.com/repos/devicons/devicon/pulls"
+    url = base_url + "pulls"
     headers = {
         "Authorization": f"token {token}"
     }
@@ -50,7 +56,7 @@ def get_merged_pull_reqs(token, page):
     }
 
     print(f"Querying the GitHub API for requests page #{page}")
-    response = requests.get(queryPath, headers=headers, params=params)
+    response = requests.get(url, headers=headers, params=params)
     if not response:
         print(f"Can't query the GitHub API. Status code is {response.status_code}. Message is {response.text}")
         sys.exit(1)
@@ -99,3 +105,80 @@ def find_all_authors(pull_req_data, token):
             authors.add(commit["commit"]["author"]["name"]) 
             print(f"This URL didn't have an `author` attribute: {pull_req_data['commits_url']}")
     return ", ".join(["@" + author for author in list(authors)])
+
+
+def label_issues(token: str, repo: str, issues: List[str], labels: List[str]):
+    """
+    Label the issues specified with the label specified.
+    :param token: the GitHub API token.
+    :param issues: the issue numbers (as str) that we are labelling.
+    :param labels: the labels that we are labelling.
+    """
+    headers = {
+        "Authorization": f"token {token}",
+        "accept": "application/vnd.github.v3+json"
+    }
+    url = base_url + "issues/{}/labels"
+    for issue in issues:
+        body = {
+            "labels": labels
+        }
+        response = requests.post(url.format(repo, issue), headers=headers, json=body)
+        if not response:
+            raise Exception(f"Can't label the Issue provided. Issue: {issue}, labels: {labels}, API response: " + response.text)
+        else:
+            print(f"Successfully labelled issue {issue}")
+
+
+def close_issues(token: str, issues: List[str]):
+    """
+    Close issues.
+    :param token: the GitHub API token.
+    :param issues: the issue numbers (as str) that we are labelling.
+    """
+    headers = {
+        "Authorization": f"token {token}",
+        "accept": "application/vnd.github.v3+json"
+    }
+    url = base_url + "issues/{}"
+    body = {
+        "state": "closed"
+    }
+    for issue in issues:
+        response = requests.patch(url.format(issue), headers=headers, json=body)
+        if not response:
+            raise Exception(f"Can't close Issue provided. Issue: {issue}, API response: " + response.text)
+        else:
+            print(f"Successfully closed issue {issue}")
+
+
+def get_issues_by_labels(token: str, labels: List[str]):
+    """
+    Get a list of issues based on their labels.
+    :param token: the GitHub API token.
+    :param labels: the labels that we are labelling.
+    """
+    url = base_url + "issues?per_page=100&labels={}&page={}"
+    headers = {
+        "Authorization": f"token {token}",
+        "accept": "application/vnd.github.v3+json"
+    }
+    issues = []
+    done = False
+    page_num = 1
+    while not done:
+        response = requests.get(url.format(",".join(labels), page_num), headers=headers)
+        if not response:
+            raise Exception(f"Can't access API. Can't get issues for labels: {labels}, API response: " + response.text)
+        else:
+            results = response.json()
+            if len(results) < 100:
+                done = True # we are done
+            else:
+                page_num += 1 # page is full => might need to check another page
+
+            # GitHub API also returns PRs for issues queries => have to check
+            issues_only = [issue for issue in results if issue.get("pull_request") is None]
+            issues.extend(issues_only)
+
+    return issues

.github/scripts/build_assets/arg_getters.py

@@ -34,28 +34,32 @@ def get_selenium_runner_args(peek_mode=False):
                         action=PathResolverAction)
 
     if peek_mode:
-        parser.add_argument("--pr_title",
+        parser.add_argument("pr_title",
                             help="The title of the PR that we are peeking at")
     else:
         parser.add_argument("token",
-                            help="The GitHub token to access the GitHub REST API.",
-                            type=str)
+                            help="The GitHub token to access the GitHub REST API.")
 
     return parser.parse_args()
 
 
-def get_check_svgs_on_pr_args():
+def get_check_icon_pr_args():
     """
-    Get the commandline arguments for the check_svgs_on_pr.py.
+    Get the commandline arguments for the check_icon_pr.py.
     """
     parser = ArgumentParser(description="Check the SVGs to ensure their attributes are correct. Run whenever a PR is opened")
-    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",
+
+    parser.add_argument("pr_title",
+                        help="The title of the PR that we are peeking at")
+
+    parser.add_argument("icons_folder_path",
+                        help="The path to the icons folder",
                         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",
+    parser.add_argument("devicon_json_path",
+                        help="The path to the devicon.json",
                         action=PathResolverAction)
+
     return parser.parse_args()
 
 
@@ -64,7 +68,25 @@ def get_release_message_args():
     Get the commandline arguments for get_release_message.py.
     """
     parser = ArgumentParser(description="Create a text containing the icons and features added since last release.")
+    parser.add_argument("token",
+                        help="The GitHub token to access the GitHub REST API.")
+    return parser.parse_args()
+
+
+def get_in_develop_labeler_args():
+    """
+    Get the commandline arguments for in_develop_labeler.py.
+    """
+    parser = ArgumentParser(description="Parse the PR body to find the issue(s) we are labelling.")
     parser.add_argument("token",
                         help="The GitHub token to access the GitHub REST API.",
                         type=str)
+
+    parser.add_argument("body",
+                        help="The PR's initial comment by the author AKA the `body` attribute of the `pull_request` API object.",
+                        type=str)
+
+    parser.add_argument("repo",
+                        help="The owner and repo name. Ex: devicons/devicon",
+                        type=str)
     return parser.parse_args()

.github/scripts/build_assets/filehandler.py

@@ -68,7 +68,7 @@ def get_svgs_paths(new_icons: List[dict], icons_folder_path: str,
         folder_path = Path(icons_folder_path, icon_info['name'])
 
         if not folder_path.is_dir():
-            raise ValueError(f"Invalid path. This is not a directory: {folder_path}.")
+            raise ValueError(f"Invalid path. This is not a directory: '{folder_path}'.")
 
         if icon_versions_only:
             get_icon_svgs_paths(folder_path, icon_info, file_paths, as_str)
@@ -100,7 +100,7 @@ def get_icon_svgs_paths(folder_path: Path, icon_info: dict,
         if path.exists():
             file_paths.append(str(path) if as_str else path)
         else:
-            raise ValueError(f"This path doesn't exist: {path}")
+            raise ValueError(f"This path doesn't exist: '{path}'")
 
 
 def get_all_svgs_paths(folder_path: Path, icon_info: dict,
@@ -119,7 +119,7 @@ def get_all_svgs_paths(folder_path: Path, icon_info: dict,
         if path.exists():
             file_paths.append(str(path) if as_str else path)
         else:
-            raise ValueError(f"This path doesn't exist: {path}")
+            raise ValueError(f"This path doesn't exist: '{path}'")
 
 
 def is_alias(font_version: str, aliases: List[dict]):
@@ -207,6 +207,14 @@ def create_screenshot_folder(dir, screenshot_name: str="screenshots/"):
     finally:
         return str(screenshot_folder)
 
+def write_to_file(path: str, value: any):
+    """
+    Write the value to a file.
+    """
+    with open(path, "w") as file:
+        file.write(value)
+
+# --- NOT USED CURRENTLY --- 
 def get_added_modified_svgs(files_added_json_path: str,
     files_modified_json_path: str):
     """
@@ -231,10 +239,3 @@ def get_added_modified_svgs(files_added_json_path: str,
 
     return svgs
 
-
-def write_to_file(path: str, value: any):
-    """
-    Write the value to a file.
-    """
-    with open(path, "w") as file:
-        file.write(value)

.github/scripts/build_assets/util.py

@@ -5,6 +5,11 @@
 import sys
 import traceback
 
+# patterns for versions
+valid_versions = "(original|plain|line)(-wordmark)?"
+valid_versions_pattern = re.compile(f"^{valid_versions}$")
+valid_svg_filename_pattern = re.compile(r"^\w+-" + valid_versions + r"\.svg$")
+
 
 def exit_with_err(err: Exception):
     """
@@ -66,3 +71,20 @@ def find_object_added_in_pr(icons: List[dict], pr_title: str):
         message = "util.find_object_added_in_pr: Couldn't find an icon matching the name in the PR title.\n" \
             f"PR title is: '{pr_title}'"
         raise Exception(message)
+
+
+def is_version_name_valid(version: str):
+    """
+    Check whether the version name is valid.
+    :param version: the version name.
+    :return bool, whether the version is valid (match our standards)
+    """
+    return valid_versions_pattern.search(version) is not None
+
+def is_svg_name_valid(filename: str):
+    """
+    Check whether the svg filename is valid.
+    :param version: the version name.
+    :return bool, whether the version is valid (match our standards)
+    """
+    return valid_svg_filename_pattern.search(filename) is not None