Skip to content

ci: Add CI step to check if precompiled regl shaders need to be updated #7786

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

Draft
camdecoster wants to merge 2 commits into
base: master
Choose a base branch
from
+64 −7
Draft

ci: Add CI step to check if precompiled regl shaders need to be updated #7786

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ea52bec
ci: Add CI step to check if precompiled regl shaders need to be updated
camdecoster Apr 30, 2026
3417dd7
Update docs
camdecoster Apr 30, 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
Prev Previous commit
Update docs
  • Loading branch information
@camdecoster
camdecoster committed Apr 30, 2026
commit 3417dd7840a186ef5a3677c3f3dd971657c63a4b
27 changes: 20 additions & 7 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,18 +163,31 @@ npm run schema
#### Step 9: REGL - Review & commit potential changes to precompiled regl shaders

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.

This is needed because regl performs codegen in runtime which breaks CSP
compliance, and so for strict builds we pre-generate regl shader code here.

The CI pipeline will automatically detect when regl-related files have changed and
run the codegen process. If the precompiled shaders are out of date, the
`check-regl-codegen` job will fail and upload a `regl-codegen` artifact containing
the updated files. To fix this:

1. Download the `regl-codegen` artifact from the failed workflow run
2. Copy the updated files into your working tree
3. Commit and push the changes to your pull request

Alternatively, you can regenerate the code locally by running:

```bash
npm run regl-codegen
```

to regenerate the regl code. This will prompt you to open a browser window. This will then 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). If no updates are necessary, it will be a no-op, but if there are changes, you will need to commit them.

This is needed because regl performs codegen in runtime which breaks CSP
compliance, and so for strict builds we pre-generate regl shader code here.
This will prompt you to open a 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).
If no updates are necessary, it will be a no-op, but if there are changes, you
will need to commit them.

#### Other npm scripts that may be of interest in development

Expand Down
Loading