feat: add action code

Author: EndBug

action.yml

@@ -0,0 +1,31 @@
+name: Label Sync
+description: An action that allows you to sync labels from a repository or a config file
+author: Federico Grandi <fgrandi30@gmail.com>
+
+runs:
+  using: node12
+  main: lib/index.js
+
+inputs:
+  token:
+    description: The token needed to edit the labels in this repo
+    required: true
+
+  config-file:
+    description: The path to the JSON or YAML file containing the label config (more info in the README)
+    required: false
+  source-repo:
+    description: The repo to copy labels from (if not using a config file), in the 'owner/repo' format
+    required: false
+  source-repo-token:
+    description: A token to use if the source repo is private
+    required: false
+
+  delete-other-labels:
+    description: Whether to delete any other label (useful when setting up a new repo, dangerous when editing an existing one)
+    required: false
+    default: 'false'
+  dry-run:
+    description: Whether to only display the changes, without making them (useful if you're worried you're going to mess up)
+    required: false
+    default: 'false'

package-lock.json

@@ -23,17 +23,19 @@
   "homepage": "https://github.com/EndBug/label-sync#readme",
   "dependencies": {
     "@actions/core": "^1.2.6",
-    "github-label-sync": "github:EndBug/github-label-sync#typings-usable"
+    "axios": "^0.20.0",
+    "github-label-sync": "github:EndBug/github-label-sync#typings-usable",
+    "yamljs": "^0.3.0"
   },
   "devDependencies": {
     "@types/node": "^14.11.5",
+    "@types/yamljs": "^0.2.31",
     "@typescript-eslint/eslint-plugin": "^4.4.0",
     "@typescript-eslint/parser": "^4.4.0",
     "@vercel/ncc": "^0.24.1",
     "eslint": "^7.10.0",
     "husky": "^4.3.0",
     "ts-node": "^9.0.0",
-    "typescript": "^4.0.3",
-    "yamljs": "^0.3.0"
+    "typescript": "^4.0.3"
   }
 }

package.json

@@ -0,0 +1,131 @@
+import core, { getInput, setFailed } from '@actions/core'
+import githubLabelSync, { LabelInfo } from 'github-label-sync'
+import fs from 'fs'
+import path from 'path'
+import yaml from 'yamljs'
+import axios from 'axios'
+
+let usingLocalFile: boolean
+
+(async () => {
+  try {
+    checkInputs()
+
+    const labels = usingLocalFile
+      ? readConfigFile(getInput('config-file'))
+      : await fetchRepoLabels(getInput('source-repo'), getInput('source-repo-token'))
+
+    const diff = await githubLabelSync({
+      accessToken: getInput('token'),
+      repo: process.env.GITHUB_REPOSITORY as string,
+      labels,
+
+      allowAddedLabels: getInput('delete-other-labels') != 'true',
+      dryRun: getInput('dry-run') == 'true'
+    })
+
+    core.startGroup('Label diff')
+    core.info(JSON.stringify(diff, null, 2))
+    core.endGroup()
+  } catch (e) { setFailed(e) }
+})
+
+function isProperConfig(value: any): value is LabelInfo[] {
+  return value instanceof Array
+    && value.every(element => (
+      typeof element == 'object'
+      && element.name && typeof element.name == 'string'
+      && element.description && typeof element.description == 'string'
+      && (
+        !element.aliases
+        || (
+          element.aliases instanceof Array
+          && element.aliases.every(alias => alias && typeof alias == 'string')
+        )
+      )
+      && (
+        !element.description
+        || typeof element.description == 'string'
+      )
+    ))
+}
+
+function readConfigFile(filePath: string) {
+  let file: string
+
+  try { // Read the file from the given path
+    file = fs.readFileSync(path.resolve(filePath), { encoding: 'utf-8' })
+    if (!file || typeof file != 'string') throw null
+  } catch {
+    throw 'Can\'t access config file.'
+  }
+
+  let parsed: LabelInfo[]
+  const fileExtension = path.extname(filePath).toLowerCase()
+
+  if (['.yaml', '.yml'].includes(fileExtension)) {
+    // Parse YAML file
+    parsed = yaml.parse(file)
+    if (!isProperConfig(parsed))
+      throw `Parsed YAML file is invalid. Parsed: ${JSON.stringify(parsed, null, 2)}`
+  } else if (fileExtension == '.json') {
+    // Try to parse JSON file
+    try {
+      parsed = JSON.parse(file)
+    } catch {
+      throw 'Couldn\'t parse JSON config file, check for syntax errors.'
+    }
+    if (!isProperConfig(parsed))
+      throw `Parsed JSON file is invalid. Parsed: ${JSON.stringify(parsed, null, 2)}`
+  } else {
+    throw `Invalid file extension: ${fileExtension}`
+  }
+
+  return parsed
+}
+
+async function fetchRepoLabels(repo: string, token?: string): Promise<LabelInfo[]> {
+  core.startGroup('Getting repo labels...')
+
+  const url = `https://api.github.com/repos/${repo}/labels`,
+    headers = token ? { Authorization: `token ${token}` } : undefined
+  core.info(`Using following URL: ${url}`)
+
+  const { data } = await axios.get(url, { headers })
+  if (!data || !(data instanceof Array))
+    throw 'Can\'t get label data from GitHub API'
+
+  core.info(`${data.length} labels fetched.`)
+  core.endGroup()
+
+  return data.map(element => ({
+    name: element.name as string,
+    color: element.color as string,
+    description: element.description as string || undefined,
+    // Can't fetch aliases from a source repo
+  }))
+}
+
+function checkInputs() {
+  if (!getInput('token'))
+    setFailed('The token parameter is required.')
+
+  const configFile = getInput('config-file'),
+    sourceRepo = getInput('source-repo')
+
+  if (!!configFile == !!sourceRepo)
+    setFailed('You can\'t use a config file and a source repo at the same time. Choose one!')
+
+  // config-file: doesn't need evaluation, will be evaluated when parsing
+  usingLocalFile = !!configFile
+
+  if (sourceRepo && sourceRepo.split('/').length != 2)
+    setFailed('Source repo should be in the owner/repo format, like EndBug/label-sync!')
+  if (sourceRepo && !getInput('source-repo-token'))
+    core.info('You\'re using a source repo without a token: if your repository is private the action won\'t be able to read the labels.')
+
+  if (!['true', 'false'].includes(getInput('delete-other-labels')))
+    setFailed('The only values you can use for the `delete-other-labels` option are `true` and `false`')
+  if (!['true', 'false'].includes(getInput('dry-run')))
+    setFailed('The only values you can use for the `dry-run` option are `true` and `false`')
+}