tldr/pages/common/github-label-sync.md

25 lines
818 B
Markdown
Raw Normal View History

2019-05-18 09:58:16 +01:00
# github-label-sync
2022-06-27 11:23:12 +01:00
> A command-line interface for synchronizing GitHub labels.
> More information: <https://github.com/Financial-Times/github-label-sync>.
2019-05-18 09:58:16 +01:00
2022-06-27 11:23:12 +01:00
- Synchronize labels using a local `labels.json` file:
2019-05-18 09:58:16 +01:00
`github-label-sync --access-token {{token}} {{repository_name}}`
2022-06-27 11:23:12 +01:00
- Synchronize labels using a specific labels JSON file:
2019-05-18 09:58:16 +01:00
`github-label-sync --access-token {{token}} --labels {{url|path/to/json_file}} {{repository_name}}`
2022-06-27 11:23:12 +01:00
- Perform a dry run instead of actually synchronizing labels:
2019-05-18 09:58:16 +01:00
`github-label-sync --access-token {{token}} --dry-run {{repository_name}}`
- Keep labels that aren't in `labels.json`:
`github-label-sync --access-token {{token}} --allow-added-labels {{repository_name}}`
2022-06-27 11:23:12 +01:00
- Synchronize using the `GITHUB_ACCESS_TOKEN` environment variable:
2019-05-18 09:58:16 +01:00
`github-label-sync {{repository_name}}`