Merge pull request #207 from pjpires/feature/allow-hex-color-codes

Sanitize the color field to allow using hex codes

Author: crazy-max

README.md

@@ -51,6 +51,8 @@ looks like:
 * `description` can be omit if your want to keep the current one
 * `from_name` allow to rename a label from one currently available on your repository
 
+**Note:** You can use hex codes for the `color` field, as that helps previewing the colors in some code editors. The leading "#" will be automatically removed.
+
 ### Workflow
 
 ```yaml

__tests__/fixtures/labels.hexcodes.yml

@@ -0,0 +1,40 @@
+- # bot
+  name: ":robot: bot"
+  color: "#69cde9"
+  description: ""
+- # bug
+  name: ":bug: bug"
+  color: "#b60205"
+  description: ""
+- # dependencies
+  name: ":game_die: dependencies"
+  color: "#0366d6"
+  description: ""
+- # documentation
+  name: ":memo: documentation"
+  color: "#c5def5"
+  description: ""
+- # duplicate
+  name: ":busts_in_silhouette: duplicate"
+  color: "#cccccc"
+  description: ""
+- # enhancement
+  name: ":sparkles: enhancement"
+  color: "#0054ca"
+  description: ""
+- # feature request
+  name: ":bulb: feature request"
+  color: "#0e8a16"
+  description: ""
+- # feedback
+  name: ":mega: feedback"
+  color: "#03a9f4"
+  description: ""
+- # future maybe
+  name: ":rocket: future maybe"
+  color: "#fef2c0"
+  description: ""
+- # good first issue
+  name: ":hatching_chick: good first issue"
+  color: "#7057ff"
+  description: ""

__tests__/labeler.test.ts

@@ -65,6 +65,25 @@ const cases = [
       delete: 4,
       error: 0
     }
+  ],
+  [
+    'labels.hexcodes.yml',
+    {
+      githubToken: 'n/a',
+      yamlFile: './__tests__/fixtures/labels.hexcodes.yml',
+      skipDelete: true,
+      dryRun: true,
+      exclude: []
+    },
+    {
+      skip: 10,
+      exclude: 0,
+      create: 0,
+      update: 0,
+      rename: 0,
+      delete: 11,
+      error: 0
+    }
   ]
 ];
 

dist/index.js

@@ -213,6 +213,9 @@ export class Labeler {
     }
 
     for (const fileLabel of await this.fileLabels) {
+      // Allow color hex codes (e.g., '#cccccc') to be set even though GitHub's API requires the # sign not to be present.
+      fileLabel.color = this.sanitizeColorString(fileLabel.color);
+
       const repoLabel = await this.getRepoLabel(fileLabel.name);
 
       // Rename
@@ -334,6 +337,10 @@ export class Labeler {
     core.info(`👉 Current labels\n${yaml.dump(labels).toString()}`);
   }
 
+  private sanitizeColorString(color: string) {
+    return color.replace(/^#/, '');
+  }
+
   private logInfo(message: string) {
     core.info(`${this.dryRun ? '[dryrun] ' : ''}${message}`);
   }