chore: label-actions comments when logs:problem label is applied

[HonkingGoose]

Changes:

• label-actions will comment when logs:problem label is applied
• Explain logs:problem label usage in the development/issue-labeling.md docs

Context:

Originally this PR was just to add a logs:formatting label and comment.

We have decided to make a logs:problem label and capture all 3 things that can go wrong with the logs:

• No logs at all
• Logs insufficient
• Logs badly formatted (wall of text in issue or comment)

After this PR gets merged, @rarkins will need to create the new label, and add a description to the label.

Documentation (please check one with an [x])

• I have updated the documentation, or
• No documentation update is required

How I've tested my work (please tick one)

I have verified these changes via:

• Code inspection only, or
• Newly added unit tests, or
• No new tests but ran on a real repository, or
• Both unit tests + ran on a real repository

[rarkins]

Do you think we need a separate label/text for each type of logs problem, or can we combine? I was thinking we can maybe combine these three cases:

• Logs are missing and we need them (including instructions on how to log locally or retrieve from the app)
• Logs provided are not sufficient and user needs to provide more
• User should format them

Or maybe we now have so many labels.. who cares if we split them?

[HonkingGoose]

So we have 2 directions we can take this.
I have listed the options below for discussion.

Option 1: separate logs labels

• logs:needed: Explain why we need a log, and explain how to log locally/retrieve from app + how to format.
• logs:insufficient: Explain that provided logs are not sufficient, explain how to log locally/retrieve from app + how to format.
• logs:formatting: Explain how to format provided logs.

Having 3 logs type labels might be too much, as we already have a lot of labels.

Option 2: one logs:problem label to rule them all

logs:problem: how to log locally/retrieve from app + how to format logs

There's a problem with the logs, we either need a log, or better logs, or the current logs are formatted poorly.
Depending on what situation applies follow one, some or all instructions:

Do .... to retrieve logs from app.
Do .... to retrieve logs from local instance.
Do .... to format the logs properly.

I like the simplicity of just one catch-all label, if there's something wrong, just slap a logs:problem label on it and be done with it. 😄
We do need to take care to craft a comment that works for all 3 use-cases.

[rarkins]

Option 2!

[HonkingGoose]

Well, I made a bunch of changes:

• Add 3 sections (No logs at all, Insufficient logs, Formatting your logs)
• Provide instructions for hosted app, and self-hosted (DRAFT!)
• Use backticks in formatting your logs example (now that I use 4 spaces for indentation backticks work properly again... 🎉 )

Ready for another round of review and suggestions.

If you want to see the current output of the draft v2 commit go to:
https://github.com/HonkingGoose/test-label-action-markdown-log-hint/issues/8

[rarkins]

Is it possible for this comment to include details/ summary collapsed sections of its own? Eg one for each case

[HonkingGoose]

Is it possible for this comment to include details/ summary collapsed sections of its own? Eg one for each case

That's a great idea! 😄 And we can actually do this, though the formatting is getting really tricky now. 👻

See https://github.com/HonkingGoose/test-label-action-markdown-log-hint/issues/10 for a example of what the draft v3 commit gives you.

We still need to improve the text for finding logs on self-hosted instances of Renovate, as that is still placeholder text basically.
EDIT: Copy/pasted instructions from our bug report template, as that had some help on finding self-hosted logs. 😄

[HonkingGoose]

I think this is ready for another review, and possibly a merge. 😄

See https://github.com/HonkingGoose/test-label-action-markdown-log-hint/issues/11 for a live preview of the message from commit 156c060.

[HonkingGoose]

Do you want me to update the development/issue-labeling.md docs within this PR as well?

I think it makes sense to add the label and some explanatory text in the issue-labeling, Housekeeping section.

[rarkins]

Great job with figuring out the nested formatting!

[HonkingGoose]

Great job with figuring out the nested formatting!

Thank you! 😄

And thank you again for merging my work! ✨

Can you create the label logs:problem, I don't have the rights needed to create labels here, I can only apply existing labels. 😉

[renovate-release]

🎉 This PR is included in version 24.94.4 🎉

The release is available on:

• GitHub release
• 24.94.4

Your semantic-release bot 📦🚀

[HonkingGoose]

@viceice can you please create a new label logs:problem? I don't have the rights to create new labels. 😉

[HonkingGoose]

@viceice or @rarkins Thank you for making the label! 🎉

By the way the label action only works on "issues" not on "pull requests":

renovate/.github/workflows/label-actions.yml

Lines 3 to 5 in ef447c7

	on:
	issues:
	types: [labeled]

I'll go try it out on a issue of mine. 😄