Skip to content

No longer publish or overwrite any "latest" bundles on CDN #5697

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

Merged
merged 5 commits into from
Jun 1, 2021
Merged

No longer publish or overwrite any "latest" bundles on CDN #5697

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
9fcef2b
no longer publish/overwrite any latest to CDN after v2
archmoj May 31, 2021
e46d570
update readme
archmoj May 31, 2021
67e8783
mention pre-release in addition to latest
archmoj May 31, 2021
6488dc4
Update README.md
archmoj Jun 1, 2021
1f2ff1f
Update README.md
archmoj Jun 1, 2021
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
19 changes: 10 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,24 +46,25 @@ var Plotly = require('plotly.js-dist')

### Use the plotly.js CDN hosted by Fastly

#### A minified plotly.js X.Y.Z release
```html
<!-- Latest compiled and minified plotly.js JavaScript -->
<script src="https://cdn.plot.ly/plotly-latest.min.js" charset="utf-8"></script>

<!-- OR use a specific plotly.js release (e.g. version 1.52.3) -->
<script src="https://cdn.plot.ly/plotly-1.52.3.min.js" charset="utf-8"></script>
<script src="https://cdn.plot.ly/plotly-1.58.4.min.js" charset="utf-8"></script>
```

<!-- OR an un-minified version is also available -->
<script src="https://cdn.plot.ly/plotly-latest.js" charset="utf-8"></script>
#### An un-minified version is also available
```html
<script src="https://cdn.plot.ly/plotly-1.58.4.js" charset="utf-8"></script>
```

and use the `Plotly` object in the window scope.

##### Please note that after v2 the "plotly-latest" outputs (e.g. https://cdn.plot.ly/plotly-latest.min.js) will no longer be updated on the CDN and stay at last v1 patch i.e. v1.58.4. Therefore, in order to upgrade to plotly.js v2 and higher, you may consider switching to a specific plotly.js version.

Fastly supports Plotly.js with free CDN service. Read more at <https://www.fastly.com/open-source>

### Download the latest release
### Download the latest release or a release candidates (rc)

[Latest Release on GitHub](https://github.com/plotly/plotly.js/releases/)
[Latest and rc releases on GitHub](https://github.com/plotly/plotly.js/releases/)

and use the plotly.js `dist` file(s). More info [here](https://github.com/plotly/plotly.js/blob/master/dist/README.md).

Expand Down
14 changes: 0 additions & 14 deletions tasks/cdn_publish.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,6 @@ fi

# get plotly.js version from its package json
version=$(node -e "console.log(require('./package.json').version);")
major=$(node -e "console.log(require('./package.json').version.split('.')[0]);")

# read tag either latest or rc
baseTag=$(node -e "var rc = require('./package.json').version.split('-')[1]; console.log(rc ? rc.split('.')[0] : 'latest');")

# if not v1 add major version to the tag e.g. latest-v2
tag=$baseTag
if [ $major -ne 1 ]; then tag=$tag-v$major; fi
echo $tag

dist=dist
sync=build/sync

Expand All @@ -36,10 +26,6 @@ for path in `ls $dist/plotly*`; do
fi

cp $path "$sync/${name}-${version}.$ext"

if [ $baseTag = "latest" ]; then
cp $path "$sync/${name}-${tag}.$ext"
fi
done

# copy topojson files over to the sync folder
Expand Down
11 changes: 2 additions & 9 deletions tasks/stats.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,6 @@ var prettySize = require('prettysize');
var common = require('./util/common');
var constants = require('./util/constants');
var pkgVersion = require('../package.json').version;
var majorVersion = pkgVersion.split('.')[0];
var theLatest = 'latest' + (
(majorVersion === '1') ? '' : ('-v' + majorVersion)
);

var pathDistREADME = path.join(constants.pathToDist, 'README.md');
var cdnRoot = 'https://cdn.plot.ly/plotly-';
Expand Down Expand Up @@ -81,7 +77,6 @@ function getInfoContent() {
'Plotly.js defaults to US English (en-US) and includes British English (en) in the standard bundle.',
'Many other localizations are available - here is an example using Swiss-German (de-CH),',
'see the contents of this directory for the full list.',
'They are also available on our CDN as ' + cdnRoot + 'locale-de-ch-' + theLatest + '.js OR ' + cdnRoot + 'locale-de-ch-' + pkgVersion + '.js',
'Note that the file names are all lowercase, even though the region is uppercase when you apply a locale.',
'',
'*After* the plotly.js script tag, add:',
Expand Down Expand Up @@ -116,12 +111,12 @@ function getMainBundleInfo() {
'',
'It be can imported as minified javascript',
'- using dist file `dist/plotly.min.js`',
'- using CDN URL ' + cdnRoot + theLatest + MINJS + ' OR ' + cdnRoot + pkgVersion + MINJS,
'- using CDN URL ' + cdnRoot + pkgVersion + MINJS,
'',
'or as raw javascript:',
'- using the `plotly.js-dist` npm package (starting in `v1.39.0`)',
'- using dist file `dist/plotly.js`',
'- using CDN URL ' + cdnRoot + theLatest + JS + ' OR ' + cdnRoot + pkgVersion + JS,
'- using CDN URL ' + cdnRoot + pkgVersion + JS,
'- using CommonJS with `require(\'plotly.js\')`',
'',
'If you would like to have access to the attribute meta information ' +
Expand Down Expand Up @@ -192,8 +187,6 @@ function makeBundleInfo(pathObj) {
'',
'| Flavor | URL |',
'| ------ | --- |',
'| Latest | ' + cdnRoot + name + '-' + theLatest + JS + ' |',
'| Latest minified | ' + cdnRoot + name + '-' + theLatest + MINJS + ' |',
'| Tagged | ' + cdnRoot + name + '-' + pkgVersion + JS + ' |',
'| Tagged minified | ' + cdnRoot + name + '-' + pkgVersion + MINJS + ' |',
'',
Expand Down