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

feat(protocol-designer, components): introduce release notes & update react-markdown to v9.0.3 #17481

Open
wants to merge 5 commits into
base: edge
Choose a base branch
from

Conversation

jerader
Copy link
Collaborator

@jerader jerader commented Feb 10, 2025

closes AUTH-1423

co-authored with @y3rsh

Overview

Introduce release notes to Pd, similarly to what we have in the app and robot releases. I also moved ReleaseNotes from the App to Components but it is unclear if Pd wants to display the release notes in the announcements modal or just have the link to Github. It seems like we will eventually want to display it in the modal.

Additionally, react-markdown was updated from v9.0.1 to 9.0.3

Test Plan and Hands on Testing

rebuild your dependencies!

Review the code and make sure it makes sense. The link to the release notes.md doc in the announcements modal isn't quite working since it is based off of a github edge link which the doc doesn't exist in edge yet. it should work after this Pr merges.

But you can check how it looks in the branch here: https://github.com/Opentrons/opentrons/blob/07dca99aaee51dc1c40fa7cb4f6317ddbc739750/protocol-designer/release-notes.md

I made sure it looks good in the app still.

Changelog

  • move ReleaseNotes and style sheet out of the app and into components
  • add react-markdown as a dependency in components and remove it from app
  • create the .md doc in protocol-designer
  • plug the link into pd announcement modal

Risk assessment

low, merging into edge so there is time to improve it. this is just the foundation. also I will need Emily B. to help write the release notes for 8.5 and probably proofread what i have written so far.


import styles from './styles.module.css'

export interface ReleaseNotesProps {
isOEMMode: boolean
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

preemptively moved this component to components because we might end up displaying it in PD.

@@ -29,6 +29,14 @@ export default defineConfig(
configFile: true,
},
}),
{
name: 'markdown-loader',
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

this is to prepare for displaying the release notes in the announcement modal in pd

@jerader jerader marked this pull request as ready for review February 10, 2025 18:26
@jerader jerader requested review from a team as code owners February 10, 2025 18:26
@jerader jerader requested review from koji and ncdiehl11 and removed request for a team February 10, 2025 18:26
@jerader
Copy link
Collaborator Author

jerader commented Feb 10, 2025

NOTE: after this PR gets approval from devs, I will follow up with Emily B. to help update the copy in the .md doc. I will also followup with design/product to see if we should display the release notes in the PD announcement modal or just keep it accessible via the github link (which is a bit weird - users don't like github).

@jerader jerader requested a review from y3rsh February 10, 2025 18:27
Copy link

codecov bot commented Feb 10, 2025

Codecov Report

Attention: Patch coverage is 11.53846% with 23 lines in your changes missing coverage. Please review.

Project coverage is 18.51%. Comparing base (aae2bfa) to head (918eee9).
Report is 19 commits behind head on edge.

Files with missing lines Patch % Lines
protocol-designer/vite.config.mts 0.00% 8 Missing ⚠️
.../src/organisms/AnnouncementModal/announcements.tsx 0.00% 7 Missing ⚠️
...RobotSettings/UpdateBuildroot/UpdateRobotModal.tsx 0.00% 2 Missing ⚠️
app/src/organisms/Desktop/UpdateAppModal/index.tsx 0.00% 2 Missing ⚠️
...RobotSettingsDashboard/RobotSystemVersionModal.tsx 0.00% 2 Missing ⚠️
components/src/molecules/ReleaseNotes/index.tsx 0.00% 2 Missing ⚠️
Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             edge   #17481      +/-   ##
==========================================
+ Coverage   18.19%   18.51%   +0.32%     
==========================================
  Files        3175     3182       +7     
  Lines      229726   231275    +1549     
  Branches     6910     7315     +405     
==========================================
+ Hits        41791    42830    +1039     
- Misses     187935   188445     +510     
Flag Coverage Δ
protocol-designer 17.71% <11.53%> (+0.33%) ⬆️

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

Files with missing lines Coverage Δ
components/src/molecules/index.ts 100.00% <100.00%> (ø)
protocol-designer/src/organisms/KnowledgeLink.tsx 100.00% <100.00%> (ø)
protocol-designer/typings/global.d.ts 100.00% <ø> (ø)
...RobotSettings/UpdateBuildroot/UpdateRobotModal.tsx 0.00% <0.00%> (ø)
app/src/organisms/Desktop/UpdateAppModal/index.tsx 0.00% <0.00%> (ø)
...RobotSettingsDashboard/RobotSystemVersionModal.tsx 0.00% <0.00%> (ø)
components/src/molecules/ReleaseNotes/index.tsx 6.81% <0.00%> (ø)
.../src/organisms/AnnouncementModal/announcements.tsx 3.37% <0.00%> (-0.06%) ⬇️
protocol-designer/vite.config.mts 0.00% <0.00%> (ø)

... and 49 files with indirect coverage changes

Copy link
Collaborator

@ncdiehl11 ncdiehl11 left a comment

Choose a reason for hiding this comment

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

looks good! left one comment about what I think is a missing tag

components/package.json Outdated Show resolved Hide resolved
@jerader jerader requested review from ncdiehl11 and koji February 11, 2025 18:28
@jerader jerader changed the title feat(protocol-designer, components): introduce release notes feat(protocol-designer, components): introduce release notes & update react-markdown to v9.0.3 Feb 11, 2025
@koji
Copy link
Contributor

koji commented Feb 11, 2025

probably we can add the following to codecov.yml

 - "protocol-designer/vite.config.mts"

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.

4 participants