10000 add markdown conversion to html and run current tests by denis-yuen · Pull Request #6093 · dockstore/dockstore · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

add markdown conversion to html and run current tests #6093

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

Jump to bottom
Merged
merged 1 commit into from
Apr 4, 2025
Merged

add markdown conversion to html and run current tests #6093

merged 1 commit into from
Apr 4, 2025

Conversation

denis-yuen
Copy link
Member
@denis-yuen denis-yuen commented Apr 1, 2025 •
edited
Loading

Description
Convert descriptions (usually Markdown) from Markdown to HTML
GitHub Markdown is a superset of CommonMark https://github.github.com/gfm/
Seems to just work, but there are a wealth of extensions and settings possible.

Review Instructions
Wait till staging/prod, examine a few automatically generated DOIs and their descriptions.

Issue
See also dockstore/swagger-java-zenodo-client#26

Security and Privacy

None

Please make sure that you've checked the following before submitting your pull request. Thanks!

  • Check that you pass the basic style checks and unit tests by running mvn clean install
  • Ensure that the PR targets the correct branch. Check the milestone or fix version of the ticket.
  • Follow the existing JPA patterns for queries, using named parameters, to avoid SQL injection
  • If you are changing dependencies, check the Snyk status check or the dashboard to ensure you are not introducing new high/critical vulnerabilities
  • Assume that inputs to the API can be malicious, and sanitize and/or check for Denial of Service type values, e.g., massive sizes
  • Do not serve user-uploaded binary images through the Dockstore API
  • Ensure that endpoints that only allow privileged access enforce that with the @RolesAllowed annotation
  • Do not create cookies, although this may change in the future
  • If this PR is for a user-facing feature, create and link a documentation ticket for this feature (usually in the same milestone as the linked issue). Style points if you create a documentation PR directly and link that instead.

@denis-yuen denis-yuen self-assigned this Apr 1, 2025
@codecov Codecov
Copy link
codecov bot commented Apr 1, 2025 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 74.21%. Comparing base (e0ab1c3) to head (22754f2).

Additional details and impacted files 
@@            Coverage Diff             @@
##             develop    #6093   +/-   ##
==========================================
  Coverage      74.21%   74.21%           
+ Complexity      5643     5642    -1     
==========================================
  Files            388      388           
  Lines          20304    20308    +4     
  Branches        2094     2094           
==========================================
+ Hits           15068    15071    +3     
  Misses          4238     4238           
- Partials         998      999    +1
Flag Coverage Δ
bitbuckettests 26.03% <0.00%> (-0.02%) ⬇️
hoverflytests 27.64% <100.00%> (+0.01%) ⬆️
integrationtests 55.77% <0.00%> (-0.02%) ⬇️
languageparsingtests 10.81% <0.00%> (-0.01%) ⬇️
localstacktests 21.30% <0.00%> (-0.01%) ⬇️
toolintegrationtests 29.88% <0.00%> (-0.01%) ⬇️
unit-tests_and_non-confidential-tests 26.29% <0.00%> (-0.01%) ⬇️
workflowintegrationtests 37.52% <0.00%> (-0.01%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@sonarqubecloud SonarQubeCloud
Copy link
sonarqubecloud bot commented Apr 1, 2025

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
100.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

@denis-yuen denis-yuen changed the title run current tests run current tests for markdown conversion Apr 1, 2025
@denis-yuen
Copy link
Member Author
denis-yuen commented Apr 2, 2025 •
edited
Loading

Manually tested via dockstore/swagger-java-zenodo-client#26
i.e. use a live token and point at sandbox with the same code there for testing

@denis-yuen denis-yuen requested review from a team, kathy-t, hyunnaye and svonworl and removed request for a team April 2, 2025 14:32
@denis-yuen denis-yuen marked this pull request as ready for review April 2, 2025 14:32
svonworl
svonworl approved these changes Apr 3, 2025
View reviewed changes
dockstore-webservice/src/main/java/io/dockstore/webservice/helpers/ZenodoHelper.java


// convert from Markdown to HTML (feels weird but plain text from (e.g.) WDL descriptors should remain unmolested even if not Markdown)
// most descriptions are just READMEs
Copy link
Contributor

Choose a reason for hiding this comment

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

Kinda makes me wonder if, someday, we should track the source (README, descriptor file, etc) or type (plain text, markdown, html) of the description.

Copy link
Member Author

Choose a reason for hiding this comment

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

#6095

@denis-yuen denis-yuen mentioned this pull request Apr 4, 2025
Open
@denis-yuen denis-yuen merged commit fbcba80 into develop Apr 4, 2025
24 checks passed
@denis-yuen denis-yuen deleted the feature/html_zenodo branch April 4, 2025 14:22
@denis-yuen denis-yuen changed the title run current tests for markdown conversion add markdown conversion to html and run current tests Apr 4, 2025
@unito-bot unito-bot mentioned this pull request Apr 18, 2 7EF4 025
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kathy-t kathy-t kathy-t approved these changes

@svonworl svonworl svonworl approved these changes

@hyunnaye hyunnaye Awaiting requested review from hyunnaye hyunnaye was automatically assigned from dockstore/dockstore

Assignees

@denis-yuen denis-yuen

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@denis-yuen @kathy-t @svonworl
0