Skip to content

Commit cf8e970

Browse files
committed
Moved how to release file from wiki to a readme file
1 parent 9fab963 commit cf8e970

File tree

1 file changed

+67
-0
lines changed

1 file changed

+67
-0
lines changed

misc/how_to_release.md

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
How to release CHAP Links Library
2+
3+
This page describes the steps required to built packages for the visualization components, and deploy them on the github pages of the project.
4+
5+
Replace the name **Component** in the deployment steps for the name of the component that is being deployed (Timeline, Graph, Network, etc).
6+
7+
# Javascript
8+
9+
The Javascript version of Component is located at js/src/component
10+
11+
- Open the javascript project in a Javascript IDE
12+
- Update @date in the header of component.js
13+
- Update @version in the header of component.js
14+
- Open CHANGELOG and add a new section for the new version. Write down the main changes.
15+
- Ensure the documentation under component/doc is updated according to the changes
16+
- Open a console
17+
18+
- Go to js/src/component
19+
- Run `sh package.sh`
20+
21+
This will update the JsDoc, minify the code, package the code into component.zip,
22+
and copy the package to js/bin.
23+
24+
# Google Web Toolkit
25+
26+
The Google Web Toolkit (GWT) version of Component is located at gwt/src/component
27+
28+
- Open the project of Component in Eclipse
29+
- Copy the updated javascript files into the GWT project under com/chap/links/public and refresh the project.
30+
- Update the @date in the header of the file .com.chap.links.Component.java
31+
- Ensure the GWT version is adjusted to the changes in the Javascript version of Component.
32+
- Open a console
33+
34+
- Go to gwt/src/Component
35+
- Run `sh package.sh`
36+
37+
This will generate javadoc, create a jar file, package it into chap-links-component.zip, and copy the package to gwt/bin.
38+
39+
- TODO: examples must also be updated
40+
41+
42+
# Github pages
43+
44+
- Copy the Javascript package component.zip from js/bin to the github pages project under js/files.
45+
- Open a console
46+
47+
- Go to js/files
48+
- Run `sh unpack.sh`
49+
50+
This will unpack the Javascript package for online usage of examples and documentation.
51+
52+
- Copy the new GWT package gwt-links-component.zip to the github pages project under gwt/files.
53+
- Open a console
54+
55+
- Go to gwt/files
56+
- Run `sh unpack.sh`
57+
58+
This will unpack the GWT package for online usage of examples and documentation.
59+
60+
- Open a console
61+
62+
- Go to /
63+
- Run `sh savefilesmap.sh`
64+
65+
This will update the file files.json containing the site map.
66+
67+
- Commit and push the gh-pages project to Github.

0 commit comments

Comments
 (0)