ci: Add CI step to check if precompiled regl shaders need to be updated#7786
Open
camdecoster wants to merge 6 commits into
Open
ci: Add CI step to check if precompiled regl shaders need to be updated#7786camdecoster wants to merge 6 commits into
camdecoster wants to merge 6 commits into
Conversation
emilykl
reviewed
May 22, 2026
Comment on lines
+46
to
+47
| # stackgl_modules/ is listed here too because the regl-* shader libs live there; | ||
| # changes can alter shader output and require regenerating the precompiled shaders. |
Contributor
There was a problem hiding this comment.
Adding an additional line of explanation (feel free to adjust if not accurate)
Suggested change
| # stackgl_modules/ is listed here too because the regl-* shader libs live there; | |
| # changes can alter shader output and require regenerating the precompiled shaders. | |
| # If any of the directories listed below have changed, we need to re-run the regl-codegen step | |
| # stackgl_modules/ is listed here too because the regl-* shader libs live there; | |
| # changes can alter shader output and require regenerating the precompiled shaders. |
emilykl
reviewed
May 22, 2026
| check-regl-codegen: | ||
| needs: [detect-changes, install-and-cibuild] | ||
| if: >- | ||
| (github.event_name == 'push' && github.ref_name == github.event.repository.default_branch) || |
Contributor
There was a problem hiding this comment.
@camdecoster Does this mean the job will only be triggered on push to master?
Contributor
There was a problem hiding this comment.
We want it to run on pull requests also, right?
emilykl
reviewed
May 22, 2026
|
|
||
| If you are implementing a new feature that involves regl shaders, or if you are | ||
| making changes that affect the usage of regl shaders, you would need to run | ||
| making changes that affect the usage of regl shaders, you would need to regenerate the precompiled regl shader code. |
Contributor
There was a problem hiding this comment.
Suggested change
| making changes that affect the usage of regl shaders, you would need to regenerate the precompiled regl shader code. | |
| making changes that affect the usage of regl shaders, you will need to regenerate the precompiled regl shader code. |
emilykl
reviewed
May 22, 2026
Comment on lines
165
to
+166
| If you are implementing a new feature that involves regl shaders, or if you are | ||
| making changes that affect the usage of regl shaders, you would need to run | ||
| making changes that affect the usage of regl shaders, you would need to regenerate the precompiled regl shader code. |
Contributor
There was a problem hiding this comment.
"if you are making changes that affect the usage of regl shaders"
How would a contributor know whether this applies to them? Is it a "if you know, you know" type of situation? Or, is there a list of files which, if they are changed, the regl shader code will definitely need to be regenerated?
emilykl
reviewed
May 22, 2026
Comment on lines
+179
to
+182
| 2. Delete `src/generated/regl-codegen/` in your working tree, then unzip the | ||
| artifact at the repo root so it replaces (rather than merges into) the | ||
| existing directory. Also overwrite the four `regl_precompiled.js` files | ||
| under `src/traces/{scattergl,scatterpolargl,splom,parcoords}/`. |
Contributor
There was a problem hiding this comment.
I don't quite follow this -- will these regl_precompiled.js files be nested inside src/generated/regl-codegen/?
If you have a link to an uploaded artifact, I can verify
emilykl
reviewed
May 22, 2026
Comment on lines
+192
to
+193
| The `rm -rf` mirrors what CI does, so any orphaned shader files left over from | ||
| previous changes get cleaned up. `npm run regl-codegen` will prompt you to open a |
Contributor
There was a problem hiding this comment.
Suggested change
| The `rm -rf` mirrors what CI does, so any orphaned shader files left over from | |
| previous changes get cleaned up. `npm run regl-codegen` will prompt you to open a | |
| The `rm -rf` step is needed to clean up any orphaned shader files left over from | |
| previous changes. `npm run regl-codegen` will prompt you to open a |
emilykl
reviewed
May 22, 2026
Comment on lines
+194
to
+196
| browser window, run through all traces with 'regl' in the tags, and store the | ||
| captured code into | ||
| [src/generated/regl-codegen](https://github.com/plotly/plotly.js/blob/master/src/generated/regl-codegen). |
Contributor
There was a problem hiding this comment.
Some of the captured code will also be stored into src/traces/{scattergl,scatterpolargl,splom,parcoords}/, right?
Or do those files need to be moved manually?
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Add a CI step to check if precompiled regl shaders need to be updated.
Closes #7785.
Changes
Testing
Notes