Use REST API to create labels if they don't exist yet

Open
#807 3 comments 4 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
github-actions, typescript
Domain
devops, tooling

Research direction

Start by tracing how the action reads its label YAML configuration and determines which labels exist. Review the linked GitHub REST API documentation for creating labels and decide how the proposed configuration option should control that behavior. Done means missing configured labels can be created before they are applied to pull requests, with the existing labeling flow preserved.

Written by the indexing model from the issue text.

Description

feature request

Description:
Add a configuration option which would allow the action to attempt to create new labels if they do not already exist.

Justification:
We have a generator which creates new components inside a monorepo. We use this labeler action to apply labels to pull requests based on which components are included in the pull request.

Currently, the majority of steps in our process are automated (including adding a new entry to our label YML file), however we still need to go to the labels page in the UI to create a new label before it can actually be added to PRs.

It's possible to use the REST API to do this separately, but I wondered whether this functionality might be well-suited as part of this action because it already has the logic to read the configuration and know which labels exist or not.

Are you willing to submit a PR?
Maybe, but I don't know if this idea would be accepted or rejected in principle first.

Dominant language
TypeScript
Stars
2.5k
Forks
488
PR merge metrics
No merged PRs in 30d

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from actions/labeler

All issues in actions/labeler

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.