https://github.com/netlify/sync-labels-action

https://github.com/netlify/sync-labels-action

Last synced: 6 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/netlify/sync-labels-action
• Owner: netlify
• License: mit
• Created: 2021-12-30T10:50:31.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2024-11-25T02:00:20.000Z (about 1 year ago)
• Last Synced: 2025-06-30T03:57:25.545Z (6 months ago)
• Language: TypeScript
• Size: 1.42 MB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 14
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

          
[![Build](https://github.com/netlify/sync-labels-action/workflows/Build/badge.svg)](https://github.com/netlify/sync-labels-action/actions)

# sync-labels-action

## Motivation

GitHub issues are great for tracking executables in a single repository. However when a single project touches multiple

repositories, it's hard to track issues across repositories.

At Netlify we use issue labels to link cross repo issues to a single project, for example we'll assign the

`proj/new-amazing-secret-feature` label to multiple issues in multiple repositories.

To avoid the need to manually add, delete or rename labels in each repository, we created this GitHub action to

automatically sync the labels.

## Usage

1. Create a rules file under `.github/labeler.yml`.

Use this example as a reference:

```yaml

- {

    repoPatterns: ['netlify/sync-labels-action'],

    labels:

      [

        { name: 'type: project', description: 'Describes a top level project issue', color: 'FBCA04' },

        { name: 'type: initiative', action: delete },

        { name: 'type: chore', color: '0E8A16', action: 'rename', rename_from: 'chore' },

      ],

  }

```

2. Create a workflow file under `.github/workflows/sync-labels.yml`.

Use this example as a reference:

```yaml

name: Sync Labels

on:

  push:

    branches: [main]

    paths:

      - '.github/labeler.yml'

      - '.github/workflows/sync-labels.yml'

jobs:

  sync-label:

    runs-on: ubuntu-latest

    steps:

      - name: Git checkout

        uses: actions/checkout@v2

      - uses: netlify/sync-labels-action@v1

        with:

          # GitHub token with access to organization repositories.

          # The default GitHub actions token is scoped to the repo the workflow runs in

          github-token: ${{ secrets.PERSONAL_ACCESS_TOKEN }}

          # optional, defaults to '.github/labeler.yml'

          rules-path: .github/labeler.yml

```

## Contributors

Please see [CONTRIBUTING.md](./CONTRIBUTING.md) for instructions on how to set up and work on this repository. Thanks

for contributing!