label-sync v3.5.63

label-sync

A delightful companion to manage Github Labels across multiple repositories.

Overview

Label Sync helps you sync Github labels across multiple repositories. Using an intuitive API you'll be able to customize repository configuration across all your projects in no time. Besides that, it also features a core package module which can be used to build highly customized workflows.

Features

• ✂️ Flexible: Compatible with JS, TS and JSON configuration.
• 🌈 Easy to use: Simply use one of the templates to start!
• 🐶 Friendly error messages: Guides you through installation and sync, no magic involved!
• 🌳 Perfect test coverage: Maintaining 100% test coverage.
• 💪 Used by giants: Used in production by companies like @prisma or @graphcms

Installation

npm init label-sync

label-sync-core creates multiple requests at once which might trigger Github's abuse detection systems. I encourage you to use https://github.com/octokit/plugin-throttling.js when setting up your client to prevent hiting abuse limits.

I suggest you use one of the prebuilt configurations as a starting point of your project. You can find more about the templates in the /examples folder.

Configuration

Besides using the core package and building the workflow on your own, you can use a set of perused builders which support JS, JSON and TS configuration options.

NOTE: Colors should be represented as hexadecimal color value without "#".

JSON

json template

JSON is the most opinionated option and the quickest option to setup Label Sync. Every value can be configured globaly or later changed in each repository scope.

{
  "strict": true,
  "labels": {
    "FAQ": {
      "color": "purple",
      "description": "Frequently asked questions"
    }
  },
  "repositories": [
    "maticzav/*",
    {
      "paths": "maticzav/graphql-*",
      "labels": {
        "extra": "red"
      },
      "strict": false
    }
  ],
  "publish": {
    "branch": "master"
  }
}

labels.config.json

repository

label

NOTE: Globs should always include organization name before repository definition, and global definitions can always be overwritten using repository specific configuration.

NOTE: Colors should be represented as hexadecimal value without "#".

JavaScript

javascript template

JavaScript configuration allows you to employ more complex file structure and perform calculations during setup.

Compared to JSON, JavaScript doesn't feature globs. Instead, each repository has to be explicitly added to the sync.

NOTE: Colors should be configured as hexadecimal color values without "#".

const shield = require('./config/graphql-shield.js')

module.exports = {
  'maticzav/graphql-shield': shield,
  'maticzav/label-sync': {
    labels: {
      bug: '123abc',
      'kind/kudos': {
        description: 'Issues which simply thank for the project.',
        color: '456def',
      },
    },
    strict: true,
  },
}

Types

type LabelConfiguration =
  | {
      description?: string
      color: string
    }
  | string

export interface RepositoryConfig {
  labels: { [name: string]: LabelConfiguration }
  strict?: boolean
}

export interface Config {
  [repository: string]: RepositoryConfig
}

TypeScript

typescript template

TypeScript configuration is very similar to JavaScript one. Atop of gaining complete control over repositories, you also gain type annotations and smart suggestions.

NOTE: TypeScript configuration relies on tsconfig.json and requires a full-blown configuration or repository to run correctly.

NOTE: Colors should be configured as hexadecimal color values without "#".

import { Config } from 'label-sync-core'
import { prismaBinding } from './repositories/prisma-binding'
import { graphqlYoga } from './repositories/graphql-yoga'

const config: Config = {
  'prisma/prisma-binding': prismaBinding,
  'prisma/graphql-yoga': {
    labels: {
      bug: '2f6923',
      'kind/kudos': {
        description: 'Issues which simply thank for the project.',
        color: '123fff',
      },
    },
    strict: false,
  },
}

export default config

Types

type LabelConfiguration =
  | {
      description?: string
      color: string
    }
  | string

export interface RepositoryConfig {
  labels: { [name: string]: LabelConfiguration }
  strict?: boolean
}

export interface Config {
  [repository: string]: RepositoryConfig
}

Advanced

Besides providing a delightful syncing tool, Label Sync also features a core package named label-sync-core. label-sync-core module is extensively used in typescript. It exposes two functions, handleSync and generateSyncReport which can help you build amazing syncing utilities from ground up.

You can read more about them in the label-sync-core package README.

License

MIT @ Matic Zavadlal