AppSuite:Upgrade app using yo - Revision history

Khgras at 09:21, 22 May 2017

2017-05-22T09:21:23Z

← Older revision		Revision as of 09:21, 22 May 2017
Line 61:		Line 61:
	== Further Reading ==		== Further Reading ==

	* In case you want to create a new app for OX App Suite, read [~~[Appsuite~~:~~GettingStarted_7~~.6.~~0 \|~~ the getting started guide]].		* In case you want to create a new app for OX App Suite, read [https://documentation.open-xchange.com/latest/ui/customize/app/first-app.html the getting started guide].

Frank.paczynski at 13:50, 10 February 2016

2016-02-10T13:50:33Z

← Older revision		Revision as of 13:50, 10 February 2016
Line 1:		Line 1:
	~~<!-- !!! -->~~
	~~<!-- PLEASE APPLY CHANGES ONLY TO THE NEW TECHNICAL DOCUMENTATION: wd/frontend/web/documentation -->~~
	~~<!-- !!! -->~~

	<div class="title">Upgrade an app using yo</div>		<div class="title">Upgrade an app using yo</div>

Frank.paczynski at 13:48, 10 February 2016

2016-02-10T13:48:27Z

← Older revision		Revision as of 13:48, 10 February 2016
Line 1:		Line 1:
			<!-- !!! -->
			<!-- PLEASE APPLY CHANGES ONLY TO THE NEW TECHNICAL DOCUMENTATION: wd/frontend/web/documentation -->
			<!-- !!! -->

	<div class="title">Upgrade an app using yo</div>		<div class="title">Upgrade an app using yo</div>

J.ohny.b: /* Development Tools */

2014-06-10T09:25:41Z

Development Tools

← Older revision		Revision as of 09:25, 10 June 2014
Line 13:		Line 13:
	$ npm outdated -g grunt-cli bower yo generator-ox-ui-module		$ npm outdated -g grunt-cli bower yo generator-ox-ui-module

	It's good to have those up-to-date, especially generator-ox-ui-module. You can update them by running <tt>npm install -g <pkg><tt>.		It's good to have those up-to-date, especially generator-ox-ui-module. You can update them by running <tt>npm install -g <pkg></tt>.

	== Upgrading a Workspace using yo ==		== Upgrading a Workspace using yo ==

J.ohny.b: /* Manually upgrading single node modules */

2014-06-06T16:25:20Z

Manually upgrading single node modules

← Older revision		Revision as of 16:25, 6 June 2014
Line 27:		Line 27:
	== Manually upgrading single node modules ==		== Manually upgrading single node modules ==

	If the approach above is a little to radical for you, because you have customized everything, you might only want to update to the latest shared grunt configuration. Go to the [https://github.com/Open-Xchange-Frontend/shared-grunt-config/releases \| releases page of shared-grunt-config] and add the name of the latest tag to your apps <tt>package.json</tt>. It should look something like		If the approach above is a little to radical for you, because you have customized everything, you might only want to update to the latest shared grunt configuration. Go to the [https://github.com/Open-Xchange-Frontend/shared-grunt-config/releases releases page of shared-grunt-config] and add the name of the latest tag to your apps <tt>package.json</tt>. It should look something like

	<code>		<code>

J.ohny.b: /* Testing the most important tasks */

2014-06-06T16:24:33Z

Testing the most important tasks

← Older revision		Revision as of 16:24, 6 June 2014
Line 48:		Line 48:
	After that, check if the directories <tt>backend</tt> and <tt>www</tt> contain files that look a little familiar. If everything seems to look fine, you can remove those directories, again.		After that, check if the directories <tt>backend</tt> and <tt>www</tt> contain files that look a little familiar. If everything seems to look fine, you can remove those directories, again.

	During this test, keep an eye on the output and check any warning or error message.		During this test, keep an eye on the output and check any warning or error message. If everything looks fine, use <tt>grunt dev</tt> task to test your app in a browser.

	== Packaging ==		== Packaging ==

J.ohny.b: gh

2014-06-06T16:21:11Z

New page

<div class="title">Upgrade an app using yo</div>

__TOC__

With the release of App Suite version 7.6.0, we moved towards more easy dependency management for UI modules. We switched to grunt as a task-runner and are using npm and bower to handle dependencies. This article should provide a short guide on what to do in order to upgrade your app to the latest and greatest version of our shared grunt configuration and other development tools.

<div style="clear: both"></div>

== Development Tools ==

First, you might want to check on the versions of the tools which are necessary for UI development.

$ npm outdated -g grunt-cli bower yo generator-ox-ui-module

It's good to have those up-to-date, especially generator-ox-ui-module. You can update them by running <tt>npm install -g <pkg><tt>.

== Upgrading a Workspace using yo ==

You can generate a new version of your workspace using:

$ yo ox-ui-module

It will prompt for every file that will be overwritten with a different version and ask whether you want to overwrite or not. It is possible to view a diff between both versions. If you have not changed any of the defaults, it is save to say <tt>yes</tt> in all of these cases. If you have changed any of these files, you might still want to overwrite the file and later only commit parts of the new things or just reset to the old version. This can be done easily with your favorite SCM tool, like git or cvs (okay, in this case may be not as easy as promised).

Please pay special attention to <tt>package.json</tt> and <tt>bower.json</tt> files, since those are the files you might have changed before. Those contain meta-information unique to your app, so they will be different from the initially generated ones.

== Manually upgrading single node modules ==

If the approach above is a little to radical for you, because you have customized everything, you might only want to update to the latest shared grunt configuration. Go to the [https://github.com/Open-Xchange-Frontend/shared-grunt-config/releases | releases page of shared-grunt-config] and add the name of the latest tag to your apps <tt>package.json</tt>. It should look something like

<code>
"shared-grunt-config": "Open-Xchange-Frontend/shared-grunt-config#v0.5.0"
</code>

where the string after the # is the tag-name that will be checked out. Save the file and run:

$ npm install --no-shrinkwrap

to make sure all your node_modules are up-to-date. If something fails, remove the node_modules directory and try again.

== Testing the most important tasks ==

A quick way to check if everything still runs fine is to run the following grunt tasks

grunt dist
grunt install:dist --prefix backend --htdoc www

After that, check if the directories <tt>backend</tt> and <tt>www</tt> contain files that look a little familiar. If everything seems to look fine, you can remove those directories, again.

During this test, keep an eye on the output and check any warning or error message.

== Packaging ==

For packaging it works similar as for the app mentioned above. You can re-run the yo generators

$ yo ox-ui-module:deb-pkg
$ yo ox-ui-module:rpm-pkg

to generate new versions of the files. However, in case of packaging the chance is even higher, that you have changed the generated files. So the best advice would be to to check the differences and cherry pick the changes into your packaging information, i.e. manually add the changes you need to your files.

== Further Reading ==

* In case you want to create a new app for OX App Suite, read [[Appsuite:GettingStarted_7.6.0 | the getting started guide]].