How do I rename a label using GitHub Labeler?

Use the `from_name` field in the YAML configuration, as shown in the README example where `wontfix` is renamed to `wontfix_it`. This automates renaming during synchronization without manual intervention.

Can GitHub Labeler handle multiple repositories at once?

No, it's designed per repository; you need separate workflow and YAML files for each repo. However, you can reuse configurations by copying or templating, but there's no built-in multi-repo sync.

GitHub Labeler vs GitHub's native label features: which is better?

GitHub Labeler is better for teams wanting automation and consistency through code, while native features suit manual, ad-hoc management. Labeler adds version control and sync but requires setup and YAML maintenance.

How to exclude certain labels from being managed?

Use the `exclude` input in the workflow to specify patterns, like `help*` or `*issue` in the README example. This prevents the action from modifying labels matching those patterns, preserving them.

What happens if the YAML file has syntax errors?

The action will fail and labels won't be updated. It's crucial to use dry-run mode in pull requests, as recommended in the workflow, to catch errors before merging changes to the main branch.

Does GitHub Labeler work with GitHub Enterprise?

Yes, it should work with GitHub Enterprise if GitHub Actions is enabled. Configure the `github-token` input with appropriate secrets, similar to standard GitHub, but verify compatibility with your Enterprise version.

Open-Awesome

Manage Labels on GitHub (create/rename/update/delete) as Code

MITTypeScriptv6.0.0

A GitHub Action to manage repository labels as code through YAML configuration.

Visit Website GitHub

169 stars15 forks0 contributors

What is Manage Labels on GitHub (create/rename/update/delete) as Code?

GitHub Labeler is a GitHub Action that manages repository labels as code. It allows developers to define labels in a YAML configuration file and automatically synchronizes them with the GitHub repository, enabling consistent label management across projects.

Target Audience

GitHub repository maintainers, DevOps engineers, and teams looking to automate and standardize label management across multiple repositories.

Value Proposition

It eliminates manual label management, ensures consistency through version-controlled configurations, and integrates seamlessly into GitHub workflows with features like dry-run validation and exclusion patterns.

Overview

GitHub Action to manage labels on GitHub

Use Cases

Best For

Automating label setup for new GitHub repositories
Enforcing consistent labeling conventions across team projects
Synchronizing labels between multiple repositories
Validating label changes in pull requests with dry-run mode
Managing labels as part of a CI/CD pipeline
Renaming or updating labels without manual intervention

Not Ideal For

Projects using issue trackers other than GitHub (e.g., GitLab, Jira)
Teams that prefer interactive, GUI-based label management without YAML configuration
Repositories with highly ephemeral labels that change frequently and aren't suitable for static definition

Pros & Cons

Pros

Declarative Label Management

Enables defining labels in a YAML file with fields for name, color, description, and rename operations, as shown in the README's configuration example, treating labels as version-controlled code.

Automated Synchronization

Automatically syncs labels on code pushes or pull requests to the configuration file, integrating seamlessly into CI/CD workflows for consistent repository management.

Dry-Run Validation

Offers a dry-run mode to preview changes without applying them, useful for validating label updates in pull requests, as specified in the workflow example to prevent errors.

Exclusion Pattern Support

Allows excluding specific labels from management using pattern matching with the `exclude` input, preserving custom or system labels, demonstrated in the README workflow.

Cons

GitHub-Only Dependency

The action is tightly coupled to GitHub's ecosystem, making it unsuitable for projects on other platforms or those considering migration, limiting its portability.

Manual Configuration Overhead

Requires maintaining a YAML file for label definitions, which can be cumbersome for teams that frequently add or modify labels ad-hoc, as updates must be manually coded.

Risk of Accidental Deletion

By default, labels not in the YAML file are deleted; while `skip-delete` can mitigate this, misconfiguration could lead to unintended label removal without careful dry-run use.

Frequently Asked Questions

Related Projects

Run GitHub Actions Locally in Terminal

Run your GitHub Actions locally 🚀

Stars71,844

Forks2,023

Last commit29 days ago

Publish GitHub Releases with Assets

📦 :octocat: GitHub Action for creating GitHub Releases

Stars5,757

Forks641

Last commit9 days ago

Push Git changes to GitHub repository without authentication difficulties

GitHub actions to push back to repository eg. updated code

Stars1,277

Forks238

Last commit3 months ago

Publish a docker image to Dockerhub

A Github Action used to build and publish Docker images

Stars793

Forks204

Last commit18 days ago

Community-curated · Updated weekly · 100% open source

Found a gem we're missing?

Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.

Submit a project Star on GitHub