Skip to content

Commit 020a508

Browse files
authored
Merge pull request #1937 from plotly/dcc-temp-packages
base to install temporary packages e.g. plotly.js-dist-min in dcc
2 parents 6ee3eee + 512c873 commit 020a508

File tree

4 files changed

+10
-2
lines changed

4 files changed

+10
-2
lines changed

components/dash-core-components/.eslintignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ lib/
44
lib/bundle.js*
55
coverage/
66
node_modules/
7+
packages/
78
.npm
89
vv/
910
venv/

components/dash-core-components/CONTRIBUTING.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,9 @@ you've pulled from upstream otherwise you may be running with an out of date
3131
`bundle.js`. See the instructions for building `bundle.js` in the [Testing
3232
Locally](README.md#testing-locally) section of README.md.
3333

34-
## Updating Plotly.js
34+
## Updating official version of Plotly.js
3535

36-
1. Update the version of `plotly.js` in package.json. Always use an exact version without "^" or "~"
36+
1. Update the version of `plotly.js-dist-min` in package.json. Always use an exact version without "^" or "~"
3737
2. Run `npm install` followed by `npm run build`, the Plotly.js artifact will be copied and bundled over as required
3838
4. Update `CHANGELOG.md` with links to the releases and a description of the changes. The message should state (see the existing `CHANGELOG.md` for examples):
3939
* If you're only bumping the patch level, the heading is "Fixed" and the text starts "Patched plotly.js". Otherwise the heading is "Updated" and the text starts "Upgraded plotly.js"
@@ -42,6 +42,11 @@ Locally](README.md#testing-locally) section of README.md.
4242
* All patch versions included, with links to their release pages and a note that these fix bugs
4343
5. When bumping the dcc version, a plotly.js patch/minor/major constitutes a dcc patch/minor/major respectively as well.
4444

45+
### Using a temporary `plotly.js-dist-min` package (or other dependencies)
46+
47+
> During integrated development of new features or bug fixes in plotly.js and dash, it may be required to install a temporary plotly.js-dist-min package (or other packages) including proposed changes. To do so, please place the `.tgz` file in `packages/` folder then `npm install` the file.
48+
49+
4550
## Financial Contributions
4651

4752
If your company wishes to sponsor development of open source dash components, please [get in touch][].
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Folder to place temporary modules e.g. plotly.js-dist-min in .tgz format

components/dash-table/cspell.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
"ignorePaths": [
44
"**/package.json",
55
"**/package-lock.json",
6+
"**/packages/**",
67
"**/node_modules/**",
78
"**/vscode-extension/**",
89
"**/.git/**",

0 commit comments

Comments
 (0)