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

Preview markdown files #4153

Merged
merged 32 commits into from
Nov 25, 2024
Merged

Preview markdown files #4153

merged 32 commits into from
Nov 25, 2024

Conversation

fiskus
Copy link
Member

@fiskus fiskus commented Sep 24, 2024

image

simplescreenrecorder-2024-11-21_13.31.50.webm
  • Unit tests
  • Changelog entry (skip if change is not significant to end users, e.g. docs only)

Copy link

codecov bot commented Sep 24, 2024

Codecov Report

Attention: Patch coverage is 50.56180% with 44 lines in your changes missing coverage. Please review.

Project coverage is 39.44%. Comparing base (d8e208c) to head (b79d128).
Report is 1 commits behind head on master.

Files with missing lines Patch % Lines
catalog/app/components/Preview/loaders/Markdown.js 6.25% 15 Missing ⚠️
catalog/app/components/FileEditor/FileEditor.tsx 0.00% 8 Missing ⚠️
catalog/app/components/Preview/quick/index.tsx 77.77% 6 Missing ⚠️
catalog/app/components/FileEditor/Controls.tsx 0.00% 4 Missing ⚠️
catalog/app/components/FileEditor/State.tsx 0.00% 3 Missing ⚠️
...app/components/Preview/quick/Markdown/Skeleton.tsx 66.66% 3 Missing ⚠️
catalog/app/containers/Bucket/File/File.js 0.00% 3 Missing ⚠️
catalog/app/components/FileEditor/index.ts 0.00% 1 Missing ⚠️
...og/app/components/Preview/quick/Markdown/index.tsx 83.33% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master    #4153      +/-   ##
==========================================
+ Coverage   39.40%   39.44%   +0.03%     
==========================================
  Files         775      779       +4     
  Lines       35163    35240      +77     
  Branches     5306     5119     -187     
==========================================
+ Hits        13857    13901      +44     
- Misses      20109    20773     +664     
+ Partials     1197      566     -631     
Flag Coverage Δ
api-python 91.29% <ø> (ø)
catalog 14.93% <50.56%> (+0.13%) ⬆️
lambda 92.02% <ø> (ø)

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.


🚨 Try these New Features:

@fiskus
Copy link
Member Author

fiskus commented Oct 10, 2024

Worth mention #3310

@fiskus fiskus marked this pull request as ready for review November 20, 2024 17:46
@fiskus fiskus requested a review from nl0 November 20, 2024 17:48
@nl0 nl0 requested a review from Copilot November 21, 2024 05:52
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Copilot reviewed 5 out of 16 changed files in this pull request and generated 1 suggestion.

Files not reviewed (11)
  • catalog/app/components/Preview/quick/Markdown/snapshots/Render.spec.tsx.snap: Language not supported
  • catalog/app/components/Preview/quick/snapshots/index.spec.tsx.snap: Language not supported
  • catalog/app/components/Preview/quick/Markdown/Skeleton.tsx: Evaluated as low risk
  • catalog/app/components/Preview/quick/index.tsx: Evaluated as low risk
  • catalog/app/components/FileEditor/index.ts: Evaluated as low risk
  • catalog/app/components/Preview/loaders/Markdown.js: Evaluated as low risk
  • catalog/app/components/Preview/quick/Markdown/index.tsx: Evaluated as low risk
  • catalog/CHANGELOG.md: Evaluated as low risk
  • catalog/app/containers/Bucket/Section.tsx: Evaluated as low risk
  • catalog/app/components/FileEditor/State.tsx: Evaluated as low risk
  • catalog/app/containers/Bucket/File/File.js: Evaluated as low risk

Copy link
Member

@nl0 nl0 left a comment

Choose a reason for hiding this comment

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

some nitpicks from me and a potential bug from copilot

@nl0
Copy link
Member

nl0 commented Nov 21, 2024

also, maybe 'back to editing' or 'continue editing' instead of 'continue writing'?

@fiskus
Copy link
Member Author

fiskus commented Nov 21, 2024

also, maybe 'back to editing' or 'continue editing' instead of 'continue writing'?

The most recent UI is on screenshot: switch with "Preview" label. So, the "Preview" (noun) is enabled or not. Instead of buttons with action verbs ("Preview" and "Continue editing")

Upd: screencast updated

@nl0
Copy link
Member

nl0 commented Nov 21, 2024

Upd: screencast updated

ok i see the new ui

tho i saw "continue writing" string in the code -- is it used for smth else?

@nl0
Copy link
Member

nl0 commented Nov 21, 2024

@fiskus should i review/approve this now or are you going to work on it further?

@fiskus
Copy link
Member Author

fiskus commented Nov 21, 2024

tho i saw "continue writing" string in the code -- is it used for smth else?

I replaced "continue writing" button with Switch on 15th of November ff5c00d, and I can't find it in the code now

@nl0
Copy link
Member

nl0 commented Nov 21, 2024

tho i saw "continue writing" string in the code -- is it used for smth else?

I replaced "continue writing" button with Switch on 15th of November ff5c00d, and I can't find it in the code now

ok, tho i was sure i saw it today while expanding the diff 🤷

nl0
nl0 previously approved these changes Nov 21, 2024
nl0
nl0 previously approved these changes Nov 21, 2024
@nl0
Copy link
Member

nl0 commented Nov 21, 2024

@fiskus are we going to release this today?

@fiskus
Copy link
Member Author

fiskus commented Nov 21, 2024

I would wait and release next time. I'm not comfortable to release something in the last minute. Especially, if I made some changes in the PR.
So, I'm going to merge it after the release.

nl0
nl0 previously approved these changes Nov 25, 2024
@fiskus fiskus added this pull request to the merge queue Nov 25, 2024
Merged via the queue into master with commit ee00195 Nov 25, 2024
38 checks passed
@fiskus fiskus deleted the fileeditor-preview branch November 25, 2024 14:15
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.

2 participants