Skip to content

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

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

Open
ivyolamit wants to merge 4 commits into
base: main
Choose a base branch
from
Open

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

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b1c33ea
[LEMS-4022/update-schema-change-message] docs(changeset):
ivyolamit Mar 26, 2026
c7cf383
[LEMS-4022/update-schema-change-message] Update GitHub action message…
ivyolamit Mar 26, 2026
dea79b0
[LEMS-4022/update-schema-change-message] Temporary commit for testing
ivyolamit Mar 26, 2026
703f113
[LEMS-4022/update-schema-change-message] undo temporary change for te…
ivyolamit Mar 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .changeset/shy-wasps-argue.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
---
---
12 changes: 7 additions & 5 deletions .github/actions/branch-compare/action.yml
View file
Open in desktop
Copy link
Copy Markdown
Contributor Author

@ivyolamit ivyolamit Mar 26, 2026

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.

Original file line number Diff line number Diff line change
Expand Up @@ -125,13 +125,15 @@ runs:
body: |
# ${{ inputs.comment-title }}: Changes Detected ⚠️

**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

@jeremywiebe jeremywiebe Mar 27, 2026

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!!!**

Follow these [steps](https://khanacademy.atlassian.net/wiki/spaces/LC/pages/4161831001/Releasing+and+deploying+a+data-schema+change+in+Perseus#tl%3Bdr) on how to release.
[See this list of post-mortems for more information.](https://khanacademy.atlassian.net/wiki/spaces/ENG/pages/4504322159/Content+Platform+Breaks)

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.
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.
Comment on lines +132 to +136
Copy link
Copy Markdown
Collaborator

@jeremywiebe jeremywiebe Mar 27, 2026

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.


```diff
${{ steps.compare-artifacts.outputs.diff-content }}
Expand Down
20 changes: 20 additions & 0 deletions packages/perseus-core/src/data-schema.ts
View file
Open in desktop
Copy link
Copy Markdown
Contributor Author

@ivyolamit ivyolamit Mar 26, 2026

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.

Original file line number Diff line number Diff line change
Expand Up @@ -1109,6 +1109,7 @@ export type PerseusGraphType =
| PerseusGraphTypeSegment
| PerseusGraphTypeSinusoid
| PerseusGraphTypeExponential
| PerseusGraphTypeLogarithm
| PerseusGraphTypeTangent;

export type PerseusGraphTypeAngle = {
Expand Down Expand Up @@ -1255,6 +1256,18 @@ export type PerseusGraphTypeAbsoluteValue = {
startCoords?: [Coord, Coord];
};

export type PerseusGraphTypeLogarithm = {
type: "logarithm";
// Two points along the logarithmic curve.
coords?: Coord[] | null;
// Two points defining the vertical asymptote line.
asymptote?: [Coord, Coord] | null;
// The initial coordinates the graph renders with.
startCoords?: Coord[];
// The initial asymptote position the graph renders with.
startAsymptote?: [Coord, Coord];
};

export type PerseusGraphTypeRay = {
type: "ray";
/** Expects a list of 2 Coords */
Expand Down Expand Up @@ -1332,6 +1345,12 @@ type TangentGraphCorrect = {
coords: CollinearTuple;
};

type LogarithmGraphCorrect = {
type: "logarithm";
coords: CollinearTuple;
asymptote: [Coord, Coord];
};

type RayGraphCorrect = {
type: "ray";
coords: CollinearTuple;
Expand All @@ -1351,6 +1370,7 @@ export type PerseusGraphCorrectType =
| SegmentGraphCorrect
| SinusoidGraphCorrect
| ExponentialGraphCorrect
| LogarithmGraphCorrect
| TangentGraphCorrect;

/** Options for the label-image widget. Asks learners to label image parts. */
Expand Down
Loading