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

remove "tasklist" in pull_request_template.md and replace with stock checkboxes #136

Merged
merged 1 commit into from
May 19, 2024

Conversation

jtnord
Copy link
Member

@jtnord jtnord commented May 17, 2024

the ```[tasklist] caused the tasklist to be rendered as code in preview, and has often been broken this passed week.

checkboxes work, so just replace the tasklist with them.

e.g. use the preview on the existing file https://github.com/jenkinsci/.github/blob/ba0b88f732b4f48ed84c583524e2345427cd3f0c/.github/pull_request_template.md#testing-done

Testing done

Submitter checklist

Edit tasklist title
Beta Give feedback Tasklist Submitter checklist, more options

Delete tasklist

Delete tasklist block?
Are you sure? All relationships in this tasklist will be removed.
  1. Make sure you are opening from a topic/feature/bugfix branch (right side) and not your main branch!
    Options
  2. Ensure that the pull request title represents the desired changelog entry
    Options
  3. Please describe what you did
    Options
  4. Link to relevant issues in GitHub or Jira
    Options
  5. Link to relevant pull requests, esp. upstream and downstream changes
    Options
  6. Ensure you have provided tests - that demonstrates feature works or fixes the issue
    Options
Loading

the ```[tasklist] caused the tasklist to be rendered as code and not as a task list in the PRs that used this PR.

e.g. use the preview on the existing file https://github.com/jenkinsci/.github/blob/ba0b88f732b4f48ed84c583524e2345427cd3f0c/.github/pull_request_template.md#testing-done
@timja
Copy link
Member

timja commented May 17, 2024

It doesn't though? i.e. check the description from this PR or e.g. jenkinsci/acceptance-test-harness#1563

@lemeurherve
Copy link
Member

lemeurherve commented May 17, 2024

AFAIK the current syntax is the expected one for GitHub to render this block as a task list instead of a simple list.

The code block rendering is shown in the preview only, then rendered as a proper task list when submitted.

@jtnord
Copy link
Member Author

jtnord commented May 17, 2024

THen GitHub is playing beta testing as I am constantly having to remove this from my PRs. e.g. see jenkinsci/google-compute-engine-plugin#465

@jtnord
Copy link
Member Author

jtnord commented May 17, 2024

using the ```[tasklist] (ie just creating a PR in this repo)

image

@lemeurherve
Copy link
Member

That's expected, GitHub doesn't render a proper task list on preview, only when posted.

@lemeurherve
Copy link
Member

lemeurherve commented May 17, 2024

I encountered intermittent issues these last days when submitting PRs with task list returning an error message block instead, but editing the body and copy/pasting from a new template resolved it each time.

@jtnord
Copy link
Member Author

jtnord commented May 17, 2024

That's expected, GitHub doesn't render a proper task list on preview, only when posted.

? it does it you remove the bits ``` ?

I encountered intermittent issues these last days when submitting PRs with task list returning an error message block instead, but editing the body and copy/pasting from a new template resolved it each time.

I also see regularly see that.

Right so my PR is then just a regular list of checkboxes not a "tasklist" but Tasklists is on life support and will be replaced with something else in the future.

given this is often broken recently and breaks preview does this extra actually bring any value?

@jtnord jtnord changed the title fix tasklist in pull_request_template.md remove "tasklist" in pull_request_template.md and replace with stock checkboxes May 17, 2024
@timja timja requested a review from NotMyFault May 17, 2024 11:12
@lemeurherve
Copy link
Member

lemeurherve commented May 17, 2024

? it does it you remove the bits ``` ?

I don't modify nor remove the backticks when posting or editing.

Right so my thing is just a regular list of cehckboxes not a "tasklist" but Tasklists is on life support and will be replaced with something else in the future.

Thanks for the link and info!

EDIT:
Found the issue I encounter in this thread: https://github.com/orgs/community/discussions/39106#discussioncomment-9436673

given this is often broken recently and breaks preview does this extra actually bring any value?

I agree there is little to no value added with a task list compared to a normal list, they both are counted in listings.

The only diff is that there is a "done" count in the task list instead of just the total count.

image

VS

image

@jtnord
Copy link
Member Author

jtnord commented May 17, 2024

that there is a "done" count in the task list instead of just the total count.

I have never noticed that until you just pointed it out now :)

but I just marked one as done and

image

@NotMyFault NotMyFault merged commit 3ed6b4a into jenkinsci:master May 19, 2024
2 checks passed
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.

None yet

4 participants