Merge pull request #106 from creativecommons/message_invalid_labels

Find issues with invalid labels and export them in a report

Author: kgodey

.github/workflows/normalize_repos.yml

@@ -1,5 +1,6 @@
 name: Normalize Repos
-on: 
+on:
+  workflow_dispatch:
   schedule:
   - cron: '0 0 * * *'
   push:
@@ -26,3 +27,8 @@ jobs:
         pipenv run python normalize_repos.py
       env:
         ADMIN_GITHUB_TOKEN: ${{ secrets.ADMIN_GITHUB_TOKEN }}
+    - name: Export a report of invalid issues
+      uses: actions/upload-artifact@v2
+      with:
+        name: invalid-issue-report
+        path: /tmp/invalid_issues.yml

normalize_repos/get_labels.py

@@ -6,6 +6,23 @@
 from models import Group, Label
 
 
+def get_groups():
+    """
+    Get the list of label groups.
+    @return: the list of label groups.
+    """
+
+    labels_dict = load_yaml_from_file("labels")
+    groups = []
+    for group_info in labels_dict["groups"]:
+        group = Group(**group_info)
+        label_names = group_info.pop("labels", [])
+        groups.append(group)
+        for label_info in label_names:
+            Label(**label_info, group=group)
+    return groups
+
+
 def get_standard_labels():
     """
     Get the list of standard labels that apply to every repository.
@@ -93,13 +110,13 @@ def get_datafile_path(file_name):
 
 def get_labels():
     """
-    Get the standard list of packages and the repository-specific labels.
-    @return: the standard list of packages and the repository-specific labels
+    Get the list of standard and repository-specific labels.
+    @return: the list of standard and repository-specific labels
     """
 
     standard_labels = get_standard_labels()
     repo_specific_labels = get_repo_specific_labels()
     return standard_labels, repo_specific_labels
 
 
-__all__ = ["get_labels"]
+__all__ = ["get_labels", "get_groups"]

normalize_repos/labels.yml

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

normalize_repos/models.py

@@ -8,12 +8,18 @@ class Group:
     - name, which may be prefixed to all child label names
     - color, which acts as a fallback for child labels that do not specify one
     - is_prefixed, which determines if group name is prefixed on child labels
+    - is_required, which determines if >=1 sub-label must be applied on issues
     """
 
-    def __init__(self, color=None, is_prefixed=True, **kwargs):
+    def __init__(
+        self, color=None, is_prefixed=True, is_required=False, **kwargs
+    ):
         self.name = kwargs["name"]
         self.color = color
         self.is_prefixed = is_prefixed
+        self.is_required = is_required
+
+        self.labels = []  # This may or may not be populated, do not rely
 
     def __str__(self):
         return self.name
@@ -42,6 +48,8 @@ def __init__(self, group=None, color=None, has_emoji_name=True, **kwargs):
         self.has_emoji_name = has_emoji_name
 
         self.group = group
+        if group and self not in group.labels:
+            group.labels.append(self)
 
     @property
     def color(self):

normalize_repos/normalize_repos.py

@@ -17,8 +17,9 @@
 import yaml  # For converting .cc-metadata.yml to Python dictionary
 
 # Local/library specific
-from get_labels import get_labels
+from get_labels import get_labels, get_groups
 from set_labels import set_labels
+from validate_issues import validate_issues
 from utils import get_cc_organization, set_up_github_client
 import branch_protections
 import log
@@ -62,6 +63,9 @@ def setup():
         action="store_true",
         help="skip labels update",
     )
+    ap.add_argument(
+        "--skip-issues", action="store_true", help="skip issue labels check"
+    )
     args = ap.parse_args()
     return args
 
@@ -97,6 +101,15 @@ def set_repo_labels(args, repos):
     logger.log(log.SUCCESS, "done.")
 
 
+def validate_issue_labels(args, repos):
+    if args.skip_issues:
+        return
+    logger.log(logging.INFO, "Checking issues...")
+    groups = get_groups()
+    validate_issues(repos, groups)
+    logger.log(log.SUCCESS, "done.")
+
+
 def is_engineering_project(repo):
     try:
         contents = repo.get_contents(".cc-metadata.yml")
@@ -160,6 +173,7 @@ def main():
     logger.log(logging.INFO, "Starting normalization")
     repos = get_select_repos(args)
     set_repo_labels(args, repos)
+    validate_issue_labels(args, repos)
     update_branches(args, repos)