Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shresht7/label-sync-action
GitHub Action to synchronize and manage your repository's labels 🏷
https://github.com/shresht7/label-sync-action
github-actions labels
Last synced: 3 months ago
JSON representation
GitHub Action to synchronize and manage your repository's labels 🏷
- Host: GitHub
- URL: https://github.com/shresht7/label-sync-action
- Owner: Shresht7
- License: mit
- Created: 2021-04-08T05:49:26.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-09-12T18:47:54.000Z (4 months ago)
- Last Synced: 2024-10-13T11:33:29.730Z (3 months ago)
- Topics: github-actions, labels
- Language: TypeScript
- Homepage:
- Size: 1.61 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Label Sync
[](https://github.com/Shresht7/label-sync-action/releases)
[](./LICENSE)
GitHub Action to create, update, and delete labels from your repository declaratively
[](https://github.com/Shresht7/label-sync-action/actions/workflows/test.yml)
[](https://github.com/Shresht7/label-sync-action/actions/workflows/validate.yml)
[](https://github.com/Shresht7/label-sync-action/actions/workflows/action-readme.yml)
Table of Contents
- [📑 Permissions](#-permissions)
- [📖 Usage](#-usage)
- [Example Config](#example-config)
- [📋 Inputs](#-inputs)
- [� License](#-license)
---
You can _create_, _update_ and _delete_ labels declaratively by editing a config-file.
## 📑 Permissions
This action needs the `GITHUB_TOKEN` secret to use the GitHub API in order to modify labels.
## 📖 Usage
Create a workflow file (e.g. `.github/workflows/label-sync.yaml`) and configure the input parameters.
```yaml
# ============================================
# LABEL-SYNC
# --------------------------------------------
# GitHub Action to manage labels declaratively
# ============================================
name: Label Sync
# Activation Events
# =================
on:
# When .github/labels.yml changes are pushed to the default branch
push:
branches:
- main
paths:
- .github/labels.yml
# When a workflow event is dispatched manually
workflow_dispatch:
# Jobs
# ====
jobs:
label-sync:
runs-on: ubuntu-latest
name: Label Sync
steps:
# Actions/Checkout
# ================
- name: Checkout
uses: actions/checkout@v4
# Execute label-sync action
# =========================
- name: label-sync
uses: Shresht7/label-sync-action@main
id: label-sync
with:
dryrun: false # Will not make any actual changes if true (default: true)
create: true # If true, label-sync has permissions to create labels (default: true)
update: true # If true, label-sync has permissions to update labels (default: true)
delete: false # If true, label-sync has permissions to delete labels (default: false)
env:
# Needed to make use of the GitHub API to modify labels and update .github/labels.yml file
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```
> NOTE: Potential changes will only be logged if dry run is `true`. For label-sync to actually modify anything you will have to set `dryrun` to `false`.
### Example Config
The config file (`.github/labels.yaml`) will look something like this:
```yaml
- name: bug
color: ee1111
description: Something isn't working
- name: documentation
color: 0e8a16
description: Improvements or additions to the documentation
- name: enhancement
color: a2eeef
description: New feature or request
```
> NOTE: If you're prefixing colors with a `#` then wrap them with quotation marks (like '#ffffff') or yaml will think anything following the `#` is a comment.
## 📋 Inputs
| Input | Description | Default | Required |
| :------- | :------------------------------------------------------------------- | -------------------: | :------: |
| `config` | Path to the files containing the label configurations. (Can be URLs) | `.github/labels.yml` | |
| `create` | If true, label-sync has permission to create labels | `true` | |
| `update` | If true, label-sync has permission to update labels | `true` | |
| `delete` | If true, label-sync has permission to delete labels | `false` | |
| `dryrun` | Dry-run toggle. label-sync will not make any actual changes if true | `true` | |
---
## 📑 License
> [MIT License](./LICENSE)