Skip to content

Commit ee2f88c

Browse files
committed
add documentation
1 parent 6918e6f commit ee2f88c

2 files changed

Lines changed: 14 additions & 0 deletions

File tree

.github/workflows/upload-dev-build.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
name: Upload dev build from PR
22

3+
# See https://github.com/plotly/plotly.js/blob/master/CONTRIBUTING.md#live-links-to-dev-builds
4+
# for documentation on the usage of this workflow.
5+
36
on:
47
workflow_run:
58
workflows: ["Publish Dist"] # publish-dist.yml

CONTRIBUTING.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -326,6 +326,17 @@ This will produce the following plot, and say you want to simulate a selection p
326326

327327
<img src="https://user-images.githubusercontent.com/31989842/38890553-0bc6190c-4282-11e8-8efc-077bf05ca565.png">
328328

329+
### Live links to dev builds
330+
331+
The [Upload dev build from PR](.github/workflows/upload-dev-build.yml) workflow can be used to upload a dev build for a PR to the plotly.js-dev-builds repo, creating a live link to the plotly.js dev build which can be used in online coding environments to test and demo the PR.
332+
333+
It is triggered in one of two ways:
334+
- Automatically on completion of the Publish Dist workflow, if triggered by a PR from a branch in the main repo (not a fork).
335+
- Manually via the Actions tab in the GitHub UI, by entering a PR number in the workflow inputs
336+
- Only users with write access to the plotly.js repo can trigger workflows manually
337+
338+
If you would like a link to the dev build for your PR but don't have permission to trigger the workflow, tag a maintainer to request a run for your PR.
339+
329340
## Repo organization
330341

331342
- Distributed files are in `dist/`

0 commit comments

Comments
 (0)