Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation updates #32

Merged
merged 4 commits into from
Apr 26, 2024
Merged

Documentation updates #32

merged 4 commits into from
Apr 26, 2024

Conversation

jotdl
Copy link
Collaborator

@jotdl jotdl commented Apr 26, 2024

No description provided.

README.md Outdated
Comment on lines 23 to 25
regex-labeler:
matchers:
- regex: "regex"
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i think this is a confusing example because the regular expression is "regex", which doesn't make much sense, a regular expression doesn't always have the string "regex" in it.

how about another example that's more obvious to understand:

Suggested change
regex-labeler:
matchers:
- regex: "regex"
numeric-labeler:
matchers:
- numeric: "[0-9]+"

README.md Outdated
weight: 10
```

In this example the action would apply to all new issues (as no `required_labels` are set). If the issue title and/or body contains the word "regex" it would be labeled as `regex-labeler` by default. But if the word `assignment` is matched, the label `ic-assignment` would be assigned instead (given the higher weight).
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
In this example the action would apply to all new issues (as no `required_labels` are set). If the issue title and/or body contains the word "regex" it would be labeled as `regex-labeler` by default. But if the word `assignment` is matched, the label `ic-assignment` would be assigned instead (given the higher weight).
In this example the action would apply to all new issues (as no `required_labels` are set). If the issue title and/or body contains numbers it would be labeled as `numeric` by default. But if the word `assignment` is matched, the label `ic-assignment` would be assigned instead (given the higher weight).

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
ic-assignment/action.yml Outdated Show resolved Hide resolved
Copy link
Collaborator

@replay replay left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks, this is great, really useful!

@jotdl jotdl merged commit d27cc0c into main Apr 26, 2024
2 checks passed
@jotdl jotdl deleted the doc-updates branch April 26, 2024 12:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants