Incubator ECharts Website

Setup

Clone this project, alone with echarts, echarts-www, echarts-examples, echarts-doc under the same directory.

Debug Locally

Edit echarts-www/config/env.debug.js and echarts-examples/config/env.debug.js. Change host to be the path to local debug server and examples.

For example, if you use http-server to start a server http://127.0.0.1:8080 under incubator-echarts-website directory, host in the two projects should be http://127.0.0.1:8080 and http://127.0.0.1:8080/examples accordingly.

Run gulp release --dev under echarts-examples.
Run sh release.sh under echarts-doc.
Run gulp release --dev under echarts-www.
Run a server under incubator-echarts-website directory and test.

Build Release

Execute the following (optional) steps sequentially.

Prepare

export ECHARTS_BASE="/your/local/base/dir/path/of/these/projects"

If the built-in echarts dist needs to be upated

Prepare echarts source code

cd ${ECHARTS_BASE}/echarts
git checkout release # Make sure in `release branch`
git pull
git status # Make sure there is no modification in `src`.

Copy echarts dist files and source code for custom builder:

# Copy dist files:
cp -r ${ECHARTS_BASE}/echarts/dist/* ${ECHARTS_BASE}/echarts-www/dist
ls -alF ${ECHARTS_BASE}/echarts-www/dist
# Copy source code:
rm -r ${ECHARTS_BASE}/echarts-www/builder/src/echarts
rm -r ${ECHARTS_BASE}/echarts-www/builder/src/zrender
cp -r ${ECHARTS_BASE}/echarts/src ${ECHARTS_BASE}/echarts-www/builder/src/echarts
cp -r ${ECHARTS_BASE}/zrender/src ${ECHARTS_BASE}/echarts-www/builder/src/zrender
cat ${ECHARTS_BASE}/echarts-www/builder/src/echarts/echarts.js | grep version
cat ${ECHARTS_BASE}/echarts-www/builder/src/zrender/zrender.js | grep version
${ECHARTS_BASE}/echarts-www/builder/pre/removeDEV.js # remove __DEV__

If the release download list needs to be updated

code ${ECHARTS_BASE}/echarts-www/js/download.js
# Add the new release to the download list manually.

If `echarts-examples` needs to be updated

If any of the thumbnails need to be updated

cd ${ECHARTS_BASE}/echarts-examples/tool
node build-example.js

If the built-in echarts needs to be updated

cd ${ECHARTS_BASE}/echarts-examples
sh update-echarts.sh --only-copy-dist

If `incubator-echarts-website` needs to be built and published

Clear

rm -r ${ECHARTS_BASE}/echarts-www/release
rm ${ECHARTS_BASE}/echarts-www/echarts-www.zip

Build echarts-examples

sh ${ECHARTS_BASE}/echarts-examples/release.sh --env asf
# sh ${ECHARTS_BASE}/echarts-examples/release.sh --env echartsjs

Build echarts-doc Ensure “echarts-doc” is on the correct git branch (relase branch).

sh ${ECHARTS_BASE}/echarts-doc/release.sh --env asf
# sh ${ECHARTS_BASE}/echarts-doc/release.sh --env echartsjs
ls -alF ${ECHARTS_BASE}/echarts-www/documents/cn
ls -alF ${ECHARTS_BASE}/echarts-www/documents/en
ls -alF ${ECHARTS_BASE}/echarts-www/documents/asset/

Build echarts-www

sh ${ECHARTS_BASE}/echarts-www/release.sh --env asf
# sh ${ECHARTS_BASE}/echarts-www/release.sh --env echartsjs

Clear

rm -r ${ECHARTS_BASE}/echarts-www/release
rm ${ECHARTS_BASE}/echarts-www/echarts-www.zip

Then commit and push to asf-site branch.

Then initiate a building job at https://gitbox.apache.org/setup/resync.cgi by searching incubator-echarts-website.

Then wait for several minutes and Website should be generated at https://echarts.apache.org/.