github-community-projects / github-community-projects/safe-settings
Suggestion: Support include/exclude for topics
- Dominant language
- JavaScript
- Stars
- 921
- Forks
- 226
- Avg merge
- 18h 3m
- Merged PRs (30d)
- 14
Description
## Prerequisites:
* Is the functionality available in the GitHub UI? If so, please provide a link to information about the feature.
* Is the functionality available through the GitHub API? If the functionality is available, please provide links to the
API documentation (https://developer.github.com/v3/) as well as the Octokit documentation (https://octokit.github.io/).
* If the functionality is not yet available in the API, it would be helpful if you
contacted support (https://support.github.com/) or posted in the Community Forum (https://github.community/). Please
include a link to the forum post if you create one or a copy of the response from support.
## New Feature
Please describe the desired new functionality:
_Originally posted by @martinm82 in https://github.com/github/safe-settings/issues/408#issuecomment-1429571654_
Add support for alternative `topics` configuration where topics matching a given pattern can be excluded from delete operations. This allows other tools to create topics without having them deleted by safe-settings.
Example: The following config would keep the topic `team-unicorn` created by another tool or user.
```
topics:
include:
- probot
exclude:
- name: ^team-
```
Include can be used without specifying exclude in the config, while also supporting the current format:
```
topics:
- probot
```
Contributor guide
Assessment
This issue has not been assessed yet.