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

Task: remove html comments from pr description #6086

Merged
merged 2 commits into from
Aug 10, 2023

Conversation

Carreau
Copy link
Contributor

@Carreau Carreau commented Jul 24, 2023

This will edit a PR description to remove any html comment that are present, including leading/trailing whitespace and a single trailing newline if there is one.

As the PRs descriptions are often becoming Merge/rebase-squash messages, this should lead to cleaner commit messages.

Should close #6085

@github-actions github-actions bot added the task label Jul 24, 2023
@Carreau Carreau force-pushed the strip-html-comments branch 2 times, most recently from 887a4dd to 7a1289e Compare July 24, 2023 12:13
@codecov
Copy link

codecov bot commented Jul 24, 2023

Codecov Report

Merging #6086 (8c61fc5) into main (007712f) will increase coverage by 0.08%.
Report is 18 commits behind head on main.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main    #6086      +/-   ##
==========================================
+ Coverage   91.53%   91.62%   +0.08%     
==========================================
  Files         578      579       +1     
  Lines       50540    50636      +96     
==========================================
+ Hits        46264    46394     +130     
+ Misses       4276     4242      -34     
Files Changed Coverage Δ
napari/_vispy/overlays/scale_bar.py 97.72% <ø> (+0.02%) ⬆️

... and 34 files with indirect coverage changes

Some changes in main are making mypy fix on all new Pull Request.

Update typing for CI to pass.
@andy-sweet andy-sweet added the maintenance PR with maintance changes, label Jul 24, 2023
@jni jni mentioned this pull request Jul 25, 2023
15 tasks
@brisvag
Copy link
Contributor

brisvag commented Jul 25, 2023

What if a comment is explicitly added for example in a code block, like this?

<!-- I'm explaining what a comment is -->

Pretty unlikely I guess, but this would be removed and leave an empty codeblock...

@Carreau
Copy link
Contributor Author

Carreau commented Jul 25, 2023

Yeah, I guess it would be removed, but I think the PR creator, or maintainer would realize.

We can also just have a failing status if html comment is present, but that would be yet one more failing status, and I'm tempted to think that if we have issues, we can refine the code when we get there.

@Carreau Carreau marked this pull request as ready for review July 26, 2023 08:52
@Czaki Czaki added this to the 0.5.0 milestone Jul 28, 2023
@Carreau Carreau marked this pull request as draft July 30, 2023 08:08
@Carreau
Copy link
Contributor Author

Carreau commented Aug 4, 2023

It should now remove leading/training whitespace, and a single trailing new line if there is one.

@Carreau Carreau marked this pull request as ready for review August 4, 2023 08:44
@jni jni added the ready to merge Last chance for comments! Will be merged in ~24h label Aug 9, 2023
@Czaki Czaki merged commit 4e965a7 into napari:main Aug 10, 2023
38 checks passed
@Czaki Czaki removed the ready to merge Last chance for comments! Will be merged in ~24h label Aug 10, 2023
@Czaki Czaki mentioned this pull request Aug 10, 2023
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
maintenance PR with maintance changes, task
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add action that remove html comments from PR descriptions.
5 participants