Merge pull request #59 from facelessuser/feature/rework-template

Rework template config to be looked for in the local config

Author: facelessuser

.github/labels.yml

@@ -1,5 +1,7 @@
 # Wildcard labels
 
+template: 'facelessuser:master-labels:labels.yml:master'
+
 brace_expansion: true
 
 rules:

README.md

@@ -60,28 +60,25 @@ For pull requests, the configuration file in the pull gets used except when issu
 All commands issued in the body of a pull request, issue, or comment in an issue or pull request are restricted to
 owners and collaborators.
 
-## Using a Master Configuration Template
-
-You can use a master configuration file and share it across repositories. This is a good way to define common labels
-that you wish to reuse. Point to the master configuration file by setting the environmental variable `GH_CONFIG` on your
-server. It should be in the form `user:repo:path/to/config:ref`. In our case it is
-`facelessuser:master-labels:labels.yml:master`.
-
-When merging the master configuration and the local repo configuration, merging will occur as follows:
-
-- keys that contain string or bool will be override the master by the local.
-- keys that contain lists will append the local list to the master list.
-- keys that contain hashes will append the key value pair of the local to the master. In the case of duplicates, the
-  local will override.
-- One exception is with `lgtm_add`. The keys `pull_request` and `issue` will append values from the local to the master.
-  In the future, `lgtm_add` may get broken up into two separate options for consistency. This would not occur until
-  version 2.0.
-
-Even with a master configuration file, you still must specify a `.github/labels.yml` file in your repository, even if
-all it contains is an empty hash `{}`. If you specify a master configuration, if either the master or local
-configuration file fails, an empty set of options will be returned. Since repository label syncing will not occur when
-the `labels` option is missing, this will prevent all your repository labels from getting wiped out in the case of a
-failure.
+## Using a Configuration Template
+
+You can use a configuration template file and share it across repositories. This is a good way to define common labels
+that you wish to reuse. You can set the template to use in your local repository file in `.github/labels.yml`. In our
+case it is `facelessuser:master-labels:labels.yml:master`.
+
+When merging the template configuration and the local repo configuration, merging will occur as follows:
+
+- keys that contain string or bool will override the template with the local value.
+- keys that contain list values will append the local list to the template list.
+- keys that contain hash values will append the key value pair of the local to the template. In the case of duplicates,
+  the local will override.
+- One exception is with `lgtm_add`. The keys `pull_request` and `issue` will append values from the local to the
+  template. In the future, `lgtm_add` may get broken up into two separate options for consistency. This would not occur
+  until version 2.0.
+
+If either the template or local configuration file fails to be acquired, an empty set of options will be returned. Since
+repository label syncing will not occur when the `labels` option is missing, this will prevent all your repository
+labels from getting wiped out in the case of a failure.
 
 ## Triage Labels
 

label_bot/util.py

@@ -4,7 +4,6 @@
 import yaml
 import traceback
 import sys
-import os
 from gidgethub import sansio
 try:
     from yaml import CLoader as Loader
@@ -114,28 +113,8 @@ async def get_config(self, gh):
         """Get label configuration file."""
 
         await asyncio.sleep(1)
-        master_config = {}
-        master = os.environ.get("GH_CONFIG", '')
-        if master:
-            try:
-                user, repo, path, ref = master.split(':')
-                result = await gh.getitem(
-                    'https://api.github.com/repos/{user}/{repo}/contents/{path}/{?ref}',
-                    {
-                        'user': user,
-                        'repo': repo,
-                        'path': path,
-                        'ref': ref
-                    }
-                )
-                content = base64.b64decode(result['content']).decode('utf-8')
-                master_config = yaml.load(content, Loader=Loader)
-            except Exception:
-                traceback.print_exc(file=sys.stdout)
-                # Return an empty config which will cause label sync not to run
-                return master_config
-
         config = {}
+        template_config = {}
         try:
             result = await gh.getitem(
                 self.contents_url,
@@ -146,8 +125,23 @@ async def get_config(self, gh):
             )
             content = base64.b64decode(result['content']).decode('utf-8')
             config = yaml.load(content, Loader=Loader)
+            template = config.get('template', '')
+            if template:
+                user, repo, path, ref = template.split(':')
+                result = await gh.getitem(
+                    'https://api.github.com/repos/{user}/{repo}/contents/{path}/{?ref}',
+                    {
+                        'user': user,
+                        'repo': repo,
+                        'path': path,
+                        'ref': ref
+                    }
+                )
+                content = base64.b64decode(result['content']).decode('utf-8')
+                template_config = yaml.load(content, Loader=Loader)
         except Exception:
             traceback.print_exc(file=sys.stdout)
-            return config
+            # Return an empty configuration if anything went wrong
+            return template_config
 
-        return self.merge_config(master_config, config)
+        return self.merge_config(template_config, config)