Merge pull request #104 from creativecommons/json_to_yaml

Replace JSON with YAML

Author: kgodey

normalize_repos/Pipfile

@@ -8,6 +8,7 @@ allow_prereleases = true
 
 [dev-packages]
 black = "*"
+ipython = "*"
 
 [packages]
 pygithub = "*"

normalize_repos/Pipfile.lock

@@ -2,7 +2,7 @@
 
 This script ensures that all active repositories in the creativecommons GitHub
 organization are consistent in the following ways:
-* They have all the labels defined in `labels.json` present.
+* They have all the labels defined in `labels.yml` present.
 * They have standard branch protections set up (with some exceptions).
 
 This script will only update color and description of existing labels or create

normalize_repos/README.md

@@ -1,6 +1,6 @@
 # Standard library
 from pathlib import Path
-import json
+import yaml
 
 # Local/library specific
 from models import Group, Label
@@ -12,7 +12,7 @@ def get_standard_labels():
     @return: the list of standard labels
     """
 
-    labels_dict = load_json_from_file("labels")
+    labels_dict = load_yaml_from_file("labels")
     standard_labels = []
     for group_info in labels_dict["groups"]:
         label_names = group_info.pop("labels", [])
@@ -34,7 +34,7 @@ def get_repo_specific_labels():
     """
 
     skill_group = Group(color="5ff1f5", name="skill")
-    labels_dict = load_json_from_file("skills")
+    labels_dict = load_yaml_from_file("skills")
     repo_specific_labels = {}
     for repo_name, skill_names in labels_dict.items():
         skill_labels = [
@@ -63,31 +63,31 @@ def get_skill_label_from_name(skill_group, skill_name):
     )
 
 
-def load_json_from_file(file_name):
+def load_yaml_from_file(file_name):
     """
-    Load the JSON file into a Python list or dict. The extension '.json' is
+    Load the YAML file into a Python list or dict. The extension '.yml' is
     appended to the file name and only the current directory is scanned for the
     matching file.
     @param file_name: the name of the file to load
-    @return: the contents of the JSON file as a Python object
+    @return: the contents of the YAML file as a Python object
     """
 
     file_path = get_datafile_path(file_name)
     with open(file_path, "r") as file:
-        data = json.load(file)
+        data = yaml.safe_load(file)
     return data
 
 
 def get_datafile_path(file_name):
     """
     Get the path to the datafile by searching the current directory for a file
-    with the given name and the '.json' extension.
+    with the given name and the '.yml' extension.
     @param file_name: the name of the file whose path is required
     @return: the path to the file
     """
 
     current_file = Path(__file__).resolve()
-    data_file = current_file.parent.joinpath(f"{file_name}.json")
+    data_file = current_file.parent.joinpath(f"{file_name}.yml")
     return data_file
 
 
@@ -102,4 +102,4 @@ def get_labels():
     return standard_labels, repo_specific_labels
 
 
-__all__ = [get_labels]
+__all__ = ["get_labels"]

normalize_repos/get_labels.py

@@ -0,0 +1,120 @@
+groups:
+  - name: priority
+    is_required: true
+    labels:
+      - name: critical
+        color: 'UNFAVOURABLE'
+        description: Must be fixed ASAP
+        emoji: "\uD83D\uDFE5"
+      - name: high
+        color: 'NEGATIVE'
+        description: Stalls work on the project or its dependents
+        emoji: "\uD83D\uDFE7"
+      - name: medium
+        color: 'NEUTRAL'
+        description: Not blocking but should be fixed soon
+        emoji: "\uD83D\uDFE8"
+      - name: low
+        color: 'POSITIVE'
+        description: Low priority and doesn't need to be rushed
+        emoji: "\uD83D\uDFE9"
+
+  - name: status
+    is_required: true
+    labels:
+      - name: ready for work
+        color: 'LIGHT'
+        description: Ready for work
+        emoji: "\uD83C\uDFC1"
+      - name: blocked
+        color: 'MEDIUM'
+        description: Blocked & therefore, not ready for work
+        emoji: "\uD83D\uDEA7"
+      - name: ticket work required
+        color: 'DARK'
+        description: Needs more details before it can be worked on
+        emoji: "\uD83E\uDDF9"
+      - name: discarded
+        color: 'LIGHTER'
+        description: Will not be worked on
+        emoji: '⛔️'
+      - name: awaiting triage
+        color: 'DARKER'
+        description: Has not been triaged & therefore, not ready for work
+        emoji: "\uD83D\uDEA6"
+
+  - name: goal
+    color: 'ffffff'
+    is_required: true
+    labels:
+      - name: addition
+        description: Addition of new feature
+        emoji: "\uD83C\uDF1F"
+      - name: improvement
+        description: Improvement to an existing feature
+        emoji: '✨'
+      - name: fix
+        description: Bug fix
+        emoji: "\uD83D\uDEE0"
+
+  - name: aspect
+    color: '04338c'
+    is_required: true
+    labels:
+      - name: text
+        description: Concerns the textual material in the repository
+        emoji: "\uD83D\uDCC4"
+      - name: code
+        description: Concerns the software code in the repository
+        emoji: "\uD83D\uDCBB"
+      - name: interface
+        description: Concerns end-users' experience with the software
+        emoji: "\uD83D\uDD79"
+      - name: dx
+        description: Concerns developers' experience with the codebase
+        emoji: "\uD83E\uDD16"
+
+  - name: talk
+    color: 'f9bbe5'
+    labels:
+      - name: question
+        description: Can be resolved with an answer
+        emoji: '❓'
+      - name: discussion
+        description: Open for discussions and feedback
+        emoji: "\uD83D\uDCAC"
+
+  - name: friendliness
+    color: '7f0799'
+    is_prefixed: false
+    labels:
+      - name: good first issue
+        description: New-contributor friendly
+        emoji: "\uD83E\uDD17"
+        has_emoji_name: false
+      - name: help wanted
+        description: Open to participation from the community
+        emoji: "\uD83D\uDE4F"
+        has_emoji_name: false
+      - name: staff only
+        description: Restricted to CC staff members
+        emoji: "\uD83D\uDD12"
+
+standalone:
+  - name: 'ノಠ益ಠノ彡┻━┻'
+    color: '000000'
+    description: Aaargh!
+    emoji: "\uD83E\uDD2F"
+
+  - name: Hacktoberfest
+    color: '883255'
+    description: Ideal for Hacktoberfest participation
+    emoji: "\uD83C\uDF83"
+    has_emoji_name: false
+
+  - name: invalid
+    color: 'LIGHTER'
+    description: Inappropriate or invalid (ex. Hacktoberfest spam)
+    emoji: '⛔️'
+    has_emoji_name: false
+