Author: koblers
Date: Thu Apr 9 07:03:53 2015
New Revision: 1672249
URL: http://svn.apache.org/r1672249
Log:
CMS commit to olingo by koblers
Modified:
olingo/site/trunk/content/doc/javascript/project-build.mdtext
Modified: olingo/site/trunk/content/doc/javascript/project-build.mdtext
URL:
http://svn.apache.org/viewvc/olingo/site/trunk/content/doc/javascript/project-build.mdtext?rev=1672249&r1=1672248&r2=1672249&view=diff
==============================================================================
--- olingo/site/trunk/content/doc/javascript/project-build.mdtext (original)
+++ olingo/site/trunk/content/doc/javascript/project-build.mdtext Thu Apr 9
07:03:53 2015
@@ -1,66 +1,82 @@
-Title: Project build for the OData library for JavaScript
-Notice: Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
- .
- http://www.apache.org/licenses/LICENSE-2.0
- .
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-
-# Building the Olingo OData Client for JavaScript
-
-### Test tool prerequisites
-
-Open your (git-)bash and navigate to the folder
-``olingo-odata4-js/odatajs/``
-
-Entry the *grunt -version* command to show the version of the globaly
installed grund-client and the local grunt installation:
-
- $ grunt -version
- grunt-cli v0.1.13
- grunt v0.4.5
-
-### Build
-
-To build the odatajs library use the grunt task chain **build**.
-
-**``grunt build``**
-
-This task chain will perform the following grunt tasks:
-
-* ``browserify:src``
- Browserify parses the main file of the library *src/index.js* and collects
all required node modules to build an single monolitic file for easy use in the
browser. While doing this all license headers from the seperate filed will be
removed.
- The file will be saved in *build/odatajs.<version>.js*
-
-* ``uglify:build``
- Minifies and uglifies the file *build/odatajs.<version>.js* and writes the
minified version to *build/odatajs.<version>.min.js*. Also a map file
*build/datajs.2.0.0.map* is created to allow debugging
-
-* ``concat``
- Add a final licence header to the files *build/odatajs.<version>.js* and
*build/odatajs.<version>.min.js*
-
-The files will be createt in the ./build folder:
-
-* odatajs*.js
- <br/>The uncompressed library
-* odatajs*.min.js
- <br/>The minified library
-* odatajs*.map
- <br/>The map file used by the browsers to enable debugging of the minified
library
-
-
-### Check the license headers
-
-please ensure that the rat tools is properly installe (see project-setup
documentaion)
-
-**``grunt license-check``**
-
-
+Title: Project build for the OData library for JavaScript
+Notice: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+ .
+ http://www.apache.org/licenses/LICENSE-2.0
+ .
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+# Building the Olingo OData Client for JavaScript
+
+### Test tool prerequisites
+
+Open your (git-)bash and navigate to the folder
+``olingo-odata4-js/``
+
+Entry the *grunt -version* command to show the version of the globaly
installed grund-client and the local grunt installation:
+
+ $ grunt -version
+ grunt-cli v0.1.13
+ grunt v0.4.5
+
+### Build
+
+To build the odatajs library use the grunt task chain **build**.
+
+**``grunt build``**
+
+This task builds the odatajs library
+
+The files are created in the ./_build folder:
+
+* /doc-src
+ <br/>Documentation
+* /lib
+ <br/>The ODataJs library
+* /tmp
+ <br/>Folder for temporary build artefacts. E.g. logfile from the
license-check
+
+**``grunt release``**
+
+This task builds the odatajs library and creates the files for the release
+
+The files are created in the ./_dist/odatajs-<version> folder:
+
+* /doc
+ <br/>Documentation, zipped to file **odatajs-<version>-doc.zip**
+* /lib
+ <br/>Library, zipped to file **odatajs-<version>-lib.zip**
+* /sources
+ <br/>Sources, zipped to file **odatajs-<version>-sources.zip**
+
+**``release-sign``**
+
+Signs the zipped files in the /_dist folder. The signing files are also stored
in the /_dist folder.
+
+### Sign the nugget
+
+The odatajs.<version>.nupkg filed needs to be signed malually.
+
+* md5
+ <br/>>openssl dgst -md5 odatajs.4.0.0.nupkg > odatajs.4.0.0.nupkg.md5*
+* sha512
+ <br/>>gpg --print-md SHA512 odatajs.4.0.0.nupkg > odatajs.4.0.0.nupkg.sha512
+* asc
+ <br/>>gpg --armor --detach-sign odatajs.4.0.0.nupkg
+
+
+### Check the license headers
+
+please ensure that the rat tools is properly installed (see project-setup
documentaion)
+
+**``grunt license-check``**
