| <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> |
| <!-- |
| 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. |
| --> |
| <html lang="en"> |
| <head> |
| <meta http-equiv="content-type" content="text/html; charset=utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge"> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta name="description" content="Apache Olingo provides libraries which enable developers to implement OData producers and OData consumers. The available OData Java library implements OData version 2.0. In future on goal is to provide an OData 4.0 compliant library once the OData standard is published at OASIS. The focus within the community is currently on the Java technology but it is up to the community to discuss if other environments find interest."> |
| <meta name="author" content=""> |
| <link rel="icon" href="/favicon.ico"> |
| <title>Apache Olingo Library</title> |
| <!-- Bootstrap core CSS --> |
| <link href="/css/bootstrap.css" rel="stylesheet" type="text/css"><!-- Custom styles for this template --> |
| <link href="/css/navbar.css" rel="stylesheet" type="text/css"><!-- Just for debugging purposes. Don't actually copy these 2 lines! --> |
| <link href="/css/offcanvas.css" rel="stylesheet" type="text/css"><!-- Custom styles for this template --> |
| <link rel="stylesheet" href="/css/main.css"> |
| <!--[if lt IE 9]><script src="/js/ie8-responsive-file-warning.js"></script><![endif]--> |
| <style> |
| .headerlink { |
| visibility: hidden; |
| } |
| dt:hover > .headerlink, p:hover > .headerlink, td:hover > .headerlink, h1:hover > .headerlink, h2:hover > .headerlink, h3:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, h6:hover > .headerlink { |
| visibility: visible |
| } </style> |
| <script src="/js/ie-emulation-modes-warning.js" type="text/javascript"> |
| </script><!-- IE10 viewport hack for Surface/desktop Windows 8 bug --> |
| |
| <script src="/js/ie10-viewport-bug-workaround.js" type="text/javascript"> |
| </script><!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries --> |
| <!--[if lt IE 9]> |
| <script src="/js/html5shiv.min.js"></script> |
| <script src="/js/respond.min.js"></script> |
| <![endif]--> |
| </head> |
| |
| <body> |
| <div class="container"> |
| <!-- Static navbar --> |
| <div class="navbar navbar-default" role="navigation"> |
| <div class="container-fluid"> |
| <div class="navbar-header"> |
| <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse"> |
| <span class="sr-only">Toggle navigation</span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| </button> |
| <img class="navbar-brand" src="/img/OlingoOrangeTM.png" style="width:62px;" > |
| <a class="navbar-brand" href="/">Apache Olingo™</a> |
| </div> |
| <div class="navbar-collapse collapse"> |
| <ul class="nav navbar-nav"> |
| <li class="dropdown"> |
| <a href="#" class="dropdown-toggle" data-toggle="dropdown">ASF <b class="caret"></b></a> |
| <ul class="dropdown-menu"> |
| <li><a href="http://www.apache.org/foundation/">ASF Home</a></li> |
| <li><a href="http://projects.apache.org/">Projects</a></li> |
| <li><a href="http://people.apache.org/">People</a></li> |
| <li><a href="http://www.apache.org/foundation/getinvolved.html">Get Involved</a></li> |
| <li><a href="http://www.apache.org/dyn/closer.cgi">Download</a></li> |
| <li><a href="http://www.apache.org/security/">Security</a></li> |
| <li><a href="http://www.apache.org/foundation/sponsorship.html">Support Apache</a></li> |
| </ul> |
| </li> |
| |
| <li><a href="http://www.apache.org/licenses/">License</a></li> |
| |
| <li class="dropdown"> |
| <a href="#" class="dropdown-toggle" data-toggle="dropdown">Download <b class="caret"></b></a> |
| <ul class="dropdown-menu"> |
| <li><a href="/doc/odata2/download.html">Download OData 2.0 Java</a></li> |
| <li><a href="/doc/odata4/download.html">Download OData 4.0 Java</a></li> |
| <li><a href="/doc/javascript/download.html">Download OData 4.0 JavaScript</a></li> |
| </ul> |
| </li> |
| |
| <li class="dropdown"> |
| <a href="#" class="dropdown-toggle" data-toggle="dropdown">Documentation <b class="caret"></b></a> |
| <ul class="dropdown-menu"> |
| <li><a href="/doc/odata2/index.html">Documentation OData 2.0 Java</a></li> |
| <li><a href="/doc/odata4/index.html">Documentation OData 4.0 Java</a></li> |
| <li><a href="/doc/javascript/index.html">Documentation OData 4.0 JavaScript</a></li> |
| </ul> |
| </li> |
| <li><a href="/support.html">Support</a></li> |
| <li><a href="/contribute.html">Contribute</a></li> |
| |
| </ul> |
| |
| <a class="navbar-right" href="http://www.apache.org/foundation/" target="_blank"> |
| <img class="navbar-right" height="50px" src="/img/asf_logo_url.svg" alt="Apache Software Foundation"> |
| </a> |
| |
| </div><!--/.nav-collapse --> |
| </div><!--/.container-fluid --> |
| </div><!-- Main component for a primary marketing message or call to action --> |
| <h1 id="building-the-olingo-odata-client-for-javascript">Building the Olingo OData Client for JavaScript<a class="headerlink" href="#building-the-olingo-odata-client-for-javascript" title="Permalink">¶</a></h1> |
| <h3 id="test-tool-prerequisites">Test tool prerequisites<a class="headerlink" href="#test-tool-prerequisites" title="Permalink">¶</a></h3> |
| <p>Open your (git-)bash and navigate to the folder |
| <code>olingo-odata4-js/</code></p> |
| <p>Entry the <em>grunt -version</em> command to show the version of the globaly installed grund-client and the local grunt installation:</p> |
| <pre><code>$ grunt -version |
| grunt-cli v0.1.13 |
| grunt v0.4.5 |
| </code></pre> |
| <h3 id="build">Build<a class="headerlink" href="#build" title="Permalink">¶</a></h3> |
| <p>To build the odatajs library use the grunt task chain <strong>build</strong>.</p> |
| <p><strong><code>grunt build</code></strong></p> |
| <p>This task builds the odatajs library</p> |
| <p>The files are created in the ./_build folder:</p> |
| <ul> |
| <li>/doc-src |
| <br/>Documentation</li> |
| <li>/lib |
| <br/>The ODataJs library</li> |
| <li>/tmp |
| <br/>Folder for temporary build artefacts. E.g. logfile from the license-check</li> |
| </ul> |
| <p><strong><code>grunt release</code></strong></p> |
| <p>This task builds the odatajs library and creates the files for the release</p> |
| <p>The release files are created in the ./_dist/odatajs-<version> folder:</version></p> |
| <ul> |
| <li>odatajs-version-doc.zip |
| <br/>Documentation, "/doc" directory zipped to file <strong>odatajs-version-doc.zip</strong></li> |
| <li>odatajs-version-lib.zip |
| <br/>Library, zipped "/lib" directory to file <strong>odatajs-version-lib.zip</strong></li> |
| <li>odatajs-version-sources.zip |
| <br/>Sources, zipped "/sources" directory to file <strong>odatajs-version-sources.zip</strong></li> |
| </ul> |
| <p><strong><code>release-sign</code></strong></p> |
| <p>Signs the zipped files in the /_dist folder. The signing files are also stored in the /_dist folder.</p> |
| <h3 id="sign-the-nuget-package">Sign the NuGet package<a class="headerlink" href="#sign-the-nuget-package" title="Permalink">¶</a></h3> |
| <p>The odatajs.<version>.nupkg filed needs to be signed manually.</version></p> |
| <ul> |
| <li>md5 |
| <br/>>openssl dgst -md5 odatajs.4.0.0.nupkg > odatajs.4.0.0.nupkg.md5*</li> |
| <li>sha512 |
| <br/>>gpg --print-md SHA512 odatajs.4.0.0.nupkg > odatajs.4.0.0.nupkg.sha512</li> |
| <li>asc |
| <br/>>gpg --armor --detach-sign odatajs.4.0.0.nupkg</li> |
| </ul> |
| <h3 id="check-the-license-headers">Check the license headers<a class="headerlink" href="#check-the-license-headers" title="Permalink">¶</a></h3> |
| <p>Please ensure that the rat tool is properly installed (see project-setup documentaion) and run</p> |
| <p><strong><code>grunt license-check</code></strong></p> |
| <p>The license-check log files are created in the ./_build/tmp directory.</p> |
| |
| <div align="center"> |
| <p>Copyright © 2013-2022, The Apache Software Foundation<br> |
| Apache Olingo, Olingo, Apache, the Apache feather, and |
| the Apache Olingo project logo are trademarks of the Apache Software |
| Foundation.</p> |
| <small><a href="/doc/odata2/privacy.html">Privacy</a></small> |
| </div> |
| </div><!-- /container --> |
| <!-- Bootstrap core JavaScript |
| ================================================== --> |
| <!-- Placed at the end of the document so the pages load faster --> |
| <script src="/js/jquery.js" type="text/javascript"> |
| </script> |
| <script src="/js/bootstrap.js" type="text/javascript"> |
| </script> |
| <script src="/js/offcanvas.js" type="text/javascript"> |
| </script> |
| <link rel="stylesheet" href="/css/docco.css"> |
| <script src="//cdn.jsdelivr.net/gh/highlightjs/cdn-release@11.0.1/build/highlight.min.js"></script> |
| <script>hljs.highlightAll();</script> |
| </body> |
| </html> |
