Skip to content

Update GitHub action message for schema change to include release order info#3418

Open
ivyolamit wants to merge 4 commits intomainfrom
LEMS-4022/update-schema-change-message
Open

Update GitHub action message for schema change to include release order info#3418
ivyolamit wants to merge 4 commits intomainfrom
LEMS-4022/update-schema-change-message

Conversation

@ivyolamit
Copy link
Copy Markdown
Contributor

Summary:

Update GitHub action message for schema change to include release order info.
By adding a more clear information in the message this give the engineer an actionalble item by referring to the guide and order of release. And we don't forget to collaborate with #cp-eng to do publish update so we don't cause any error or break prod with these types.

Issue: LEMS-4022

Test plan:

@ivyolamit ivyolamit self-assigned this Mar 26, 2026
Copy link
Copy Markdown

@claude claude bot left a comment

Choose a reason for hiding this comment

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

Claude Code Review

This repository is configured for manual code reviews. Comment @claude review to trigger a review and subscribe this PR to future pushes, or @claude review once for a one-time review.

Tip: disable this comment in your organization's Code Review settings.

@github-actions github-actions bot added the schema-change Attached to PRs when we detect Perseus Schema changes in it label Mar 26, 2026
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Mar 26, 2026

🗄️ Schema Change: No Changes ✅

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

This is temporary change, to trigger the PR comment for schema change. Will remove this before landing the PR.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Mar 26, 2026

🛠️ Item Splitting: No Changes ✅

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Mar 26, 2026

Size Change: 0 B

Total Size: 494 kB

ℹ️ View Unchanged
Filename Size
packages/kas/dist/es/index.js 20.5 kB
packages/keypad-context/dist/es/index.js 1 kB
packages/kmath/dist/es/index.js 6.21 kB
packages/math-input/dist/es/index.js 98.5 kB
packages/math-input/dist/es/strings.js 1.61 kB
packages/perseus-core/dist/es/index.item-splitting.js 11.9 kB
packages/perseus-core/dist/es/index.js 25.1 kB
packages/perseus-editor/dist/es/index.js 101 kB
packages/perseus-linter/dist/es/index.js 9.3 kB
packages/perseus-score/dist/es/index.js 9.66 kB
packages/perseus-utils/dist/es/index.js 403 B
packages/perseus/dist/es/index.js 192 kB
packages/perseus/dist/es/strings.js 8.09 kB
packages/pure-markdown/dist/es/index.js 1.39 kB
packages/simple-markdown/dist/es/index.js 6.71 kB

compressed-size-action

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Added "Follow these steps on how to release." to make it simple but actionable, instead of adding the actual steps which makes the comment longer and it can mismatch the info in the future if there are any updates in the steps.

@ivyolamit
Copy link
Copy Markdown
Contributor Author

Before After
image image

@ivyolamit ivyolamit requested a review from a team March 26, 2026 23:31
@ivyolamit ivyolamit added the project agnostic PRs reviewable by any Perseus team member label Mar 26, 2026
@ivyolamit ivyolamit requested a review from jeremywiebe March 26, 2026 23:37
@github-actions github-actions bot removed the schema-change Attached to PRs when we detect Perseus Schema changes in it label Mar 27, 2026
@github-actions
Copy link
Copy Markdown
Contributor

npm Snapshot: NOT Published

Oh noes!! We couldn't find any changesets in this PR (703f113). As a result, we did not
publish an npm snapshot for you.

Copy link
Copy Markdown
Collaborator

@jeremywiebe jeremywiebe left a comment

Choose a reason for hiding this comment

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

Thanks for improving this messaging!!

Comment on lines +132 to +136
This PR contains critical changes to Perseus.
Please review the changes and note that you may need to
coordinate deployment of these changes with other teams
at Khan Academy, especially with #cp-eng to publish a
content update.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Suggested change
This PR contains critical changes to Perseus.
Please review the changes and note that you may need to
coordinate deployment of these changes with other teams
at Khan Academy, especially with #cp-eng to publish a
content update.
This PR contains critical changes to Perseus that affect published data.
Please review the changes and note that you may need to
coordinate deployment of these changes with other teams
at Khan Academy, especially with #cp-eng to publish a
content update.

"...content update." - I'm not totally sure I agree. Changes to the schema will affect published content after updating the publish worker, but the coordination with CP is around updating the publish worker, not updating content.


**Usually this means you need to update the Go parser
that Content Platform maintains!!!**
**Usually this means you need to update the Go parser that Content Platform maintains!!!**
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

nit: these lines were broken at the 80-char guide. Can we revert this joining here? (not everyone has soft-wrap turned on).

Suggested change
**Usually this means you need to update the Go parser that Content Platform maintains!!!**
**Usually this means you need to update the Go parser
that Content Platform maintains!!!**

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

olc-5.0.c4fcb project agnostic PRs reviewable by any Perseus team member

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants