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

[ QUESTION ] What's the purpose of ignoreComments #96

Open
Xelbayria opened this issue Nov 25, 2024 · 5 comments
Open

[ QUESTION ] What's the purpose of ignoreComments #96

Xelbayria opened this issue Nov 25, 2024 · 5 comments
Labels
question Further information is requested triage Need avaliation

Comments

@Xelbayria
Copy link

the keyword ignoreComments set to true. Is it to ignore the issue body, just focus on the title?

if it's set to false, then it will read the issue body. The Auto-label doesn't have the ability to read the comments posted by other people including myself?

@github-actions github-actions bot added question Further information is requested triage Need avaliation labels Nov 25, 2024
@Renato66
Copy link
Owner

in your issue body you can have something like this:

<!-- 
  Use this keywords to fill up the issue 
  Critical level: low, high
  "The button on login page is broken and aftects high number of users"
-->

this way you can place the labels you expect on the issue template, but when read by the action the text wouldn't be set as label and you don't need to delete the comments when submitting the issue

and if you want the opposite, ignoreComments: false

<!-- 
  Labels to apply: triage, bug, question
-->

that way every label in the comment, will be applied

@Xelbayria
Copy link
Author

I've ran an experiment. I created a new issue. The Action read the issue body and added the labels. All good but I commented on the issue with a simple words like "This isnt my issue. The issue is on the other code's issue"

so the action should have caught the keywords from the comments and add a label, "not related". which it never did. I think it only focused on the issue body, not comments.

@Renato66
Copy link
Owner

it read comments inside issue body, not comments when you comment the issue like we are doing now

@Xelbayria
Copy link
Author

Xelbayria commented Nov 26, 2024

That's what I thought at first. Unfortunately, I would like the auto-label to read the comments, so I don't have to manually add the label to the issue when it's not really related to the code but is related to other code. it happened a few times a month.

One issue with auto-label I noticed is not working very well.

under labelsSynonyms, it would look like this:

labelsSynonyms: {
	"1.20-loader": ['1.20 - loader`, `- [X] 1.20 - loader`]
}

It cannot match the keyword in the issue body but it only matched the label "1.20-loader". I tried to use labelsSynonyms: false and to exclude the "1.20-loader" and only focus on the keywords listed in the array.

There was no match at all and no label have been added. I've ran a few experiments to understand what worked and what don't work.

If i changed the keyword in the issue body: 1.20 - loader to 1.20-loader, it got matched and added the label. I was confused because of labelsSynonyms was set to be false

@Xelbayria
Copy link
Author

Just a remind that the question above is not answered.
for some reason, auto-label still added a label "details"

it's in label_issue.json5 which i don't want it to add details

looking like this:

{
	labelsNotAllowed: [
	    'duplicate',
	    'help wanted',
	    'invalid',
	    'details'
	]
}

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question Further information is requested triage Need avaliation
Projects
None yet
Development

No branches or pull requests

2 participants