From f3f3e29c954c894612a9337925e1f41dc6a920dd Mon Sep 17 00:00:00 2001 From: Owen Voke Date: Sat, 18 May 2019 09:58:16 +0100 Subject: [PATCH] github-label-sync: add page (#2967) --- pages/common/github-label-sync.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 pages/common/github-label-sync.md diff --git a/pages/common/github-label-sync.md b/pages/common/github-label-sync.md new file mode 100644 index 000000000..b273b8389 --- /dev/null +++ b/pages/common/github-label-sync.md @@ -0,0 +1,24 @@ +# github-label-sync + +> A command line interface for synchronising GitHub labels. +> Homepage: . + +- Synchronise labels using a local `labels.json` file: + +`github-label-sync --access-token {{token}} {{repository_name}}` + +- Synchronise labels using a specific labels JSON file: + +`github-label-sync --access-token {{token}} --labels {{url|path/to/json_file}} {{repository_name}}` + +- Perform a dry run instead of actually synchronising labels: + +`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}}` + +- Synchronise using the `GITHUB_ACCESS_TOKEN` environment variable: + +`github-label-sync {{repository_name}}`