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

chore: improve bug report template with log toggle #9248

Merged

Conversation

HonkingGoose
Copy link
Collaborator

Changes:

  • Contributors can now put their logs behind a nice "Click me to see logs" toggle

Context:

It's easy to post a "wall of text" log into a bug report, this results in a lot of scrolling for other contributors/maintainers.
I found out that you can "wrap" your log into a <details> + <summary> tag, so that it expands when you click on the text.

I think it's a good idea to provide the HTML needed to do the right thing the first time round, as that reduces friction for all involved.

Related to PR #9242.

I'm not closing a specific issue with this PR.

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 and others added 2 commits March 23, 2021 10:45
Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
@rarkins rarkins enabled auto-merge (squash) March 23, 2021 09:46
@HonkingGoose
Copy link
Collaborator Author

@rarkins Do you want me to put this text into this PR, to replace the current debugging help for self-hosted?

If you're running self-hosted, run with `LOG_LEVEL=debug` in your environment variables and search for whatever dependency/branch/PR that is causing the problem.

@rarkins
Copy link
Collaborator

rarkins commented Mar 23, 2021

@rarkins Do you want me to put this text into this PR, to replace the current debugging help for self-hosted?

Maybe instead we link to our debugging guide and say something like "make sure you are capturing debug logs"?

@HonkingGoose
Copy link
Collaborator Author

HonkingGoose commented Mar 23, 2021

I'm not sure what the "debugging guide" you're talking about is? Can you maybe explain more?

I found this:

Those 3 seem somewhat relevant, but I'm not sure if either of those are what you mean when you say "debugging guide".

@rarkins
Copy link
Collaborator

rarkins commented Mar 25, 2021

I was probably misremembering the local developing debugging guide. We can merge this PR as-is once you're happy with it

@rarkins rarkins enabled auto-merge (squash) March 25, 2021 10:15
@HonkingGoose
Copy link
Collaborator Author

@rarkins I'm happy with this, lets get it merged. 😉

@rarkins rarkins merged commit d516bd6 into renovatebot:master Mar 25, 2021
@HonkingGoose HonkingGoose deleted the chore/improve-bug-report-template branch March 25, 2021 10:24
@renovate-release
Copy link
Collaborator

🎉 This PR is included in version 24.94.4 🎉

The release is available on:

Your semantic-release bot 📦🚀

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Apr 25, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants