Skip to content

markdown fields in revdep_check_failure.yml #7771

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.

Sign up for GitHub

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

Open
tdhock wants to merge 3 commits into
base: master
Choose a base branch
from
+4 −5
Open

markdown fields in revdep_check_failure.yml #7771

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
edb6b75
markdown fields in revdep_check_failure.yml
tdhock May 30, 2026
ab2a391
type: input
tdhock May 30, 2026
d282782
input
tdhock May 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions .github/ISSUE_TEMPLATE/revdep_check_failure.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,16 +19,15 @@ body:
validations:
required: true

- type: textarea
- type: input
Copy link
Copy Markdown
Contributor

@Keykyrios Keykyrios May 30, 2026

Choose a reason for hiding this comment

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

type: input creates a single-line text field, which won't work for the check-output field. Users need to paste multi-line R CMD check output here (as you did in #7770, that output is 50+ lines).

Since render: text is already removed in this PR, the only remaining fix is to revert type back to textarea, that will give multi-line support and markdown rendering.

id: check-output
attributes:
label: Failing check output
description: |
Paste the relevant `R CMD check` output showing the failure.
Write markdown describing the relevant `R CMD check` output showing the failure.
Copy link
Copy Markdown
Contributor

@Keykyrios Keykyrios May 30, 2026

Choose a reason for hiding this comment

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

Since the field will now render as markdown, it might be helpful to suggest users wrap their check output in a fenced code block so it doesn't render as broken markdown. Maybe something like:

Describe the relevant R CMD check output showing the failure. Paste check output inside a fenced code block (triple backticks).

This way users get the best of both worlds, they can write markdown context around the check output while the output itself stays readable

The output can be found in the
[Monsoon results](https://rcdata.nau.edu/genomic-ml/data.table-revdeps/analyze/)
or from a local revdep check.
render: text
validations:
required: true

Expand All @@ -44,12 +43,12 @@ body:
validations:
required: true

- type: textarea
- type: input
Copy link
Copy Markdown
Contributor

@Keykyrios Keykyrios May 30, 2026

Choose a reason for hiding this comment

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

Same issue here type: input is single-line. This field is where users include MREs, multiple links, @mentions, etc. which are inherently multi-line. Should remain textarea.

id: additional-context
attributes:
label: Additional context
description: |
Any other relevant information: @mentions of the commit/PR
Write markdown with any other relevant information: @mentions of the commit/PR
author(s), links to Monsoon result pages, whether the fix
should come from data.table or from the revdep package, etc.
Minimal reproducible examples (MRE) can also be included here.
Loading