Skip to content

Commit

Permalink
Updated team build tutorials, known issues for RTM and added Cordova …
Browse files Browse the repository at this point in the history
…5 tutorials
  • Loading branch information
Chuxel committed Jul 1, 2015
1 parent 9ca9e88 commit acab90f
Show file tree
Hide file tree
Showing 41 changed files with 984 additions and 165 deletions.
13 changes: 10 additions & 3 deletions Readme.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,20 @@
# Visual Studio Tools for Apache Cordova
This repository contains a set of documents and tutorials for the **Visual Studio 2015 RC** release of **[Tools for Apache Cordova](http://aka.ms/cordova).**
This repository contains a set of documents and tutorials for the **Visual Studio 2015** release of **[Tools for Apache Cordova](http://aka.ms/cordova).**

**Note that this documentation does not apply to Visual Studio 2013 CTPs.**
**Note that, with the exception of known issues, this documentation does not apply to Visual Studio 2013 CTPs.**

<a name="tutorials"></a>
## Tutorials
1. [Using Apache Cordova 5](./tutorial-cordova-5)
1. [An Introduction to Cordova 5 Security](./tutorial-cordova-5/cordova-5-security.md)
1. [Using Gulp with your Cordova projects](./tutorial-gulp)
1. [Using Gulp to Build Cordova Projects](./tutorial-gulp/gulp-ci.md)
1. [Invoking Gulp Tasks During a Cordova Build and the VS Task Runner Explorer](./tutorial-gulp/gulp-task-runner-explorer.md)
1. [Compiling TypeScript wit Gulp](./tutorial-gulp/gulp-typescript.md)
1. [Building Cordova Apps in a Team / Continuous Integration Environment](./tutorial-team-build)
1. [Getting Start with Cordova & TFS 2015 or Visual Studio Online](./tutorial-team-build/TFS2015.md)
1. [Getting Start with Cordova & TFS 2013](./tutorial-team-build/TFS2013.md)
1. [Getting Start with Cordova & Jenkins CI](./tutorial-team-build/Jenkins.md)
1. [Package & Publish your Cordova Applications](./tutorial-package-publish)

<a name="tips"></a>
Expand All @@ -30,7 +38,6 @@ This repository contains a set of documents and tutorials for the **Visual Studi
1. [Visual Studio 2015](./known-issues/known-issues-vs2015.md)
1. [CTP 3.1 / Visual Studio 2013](./known-issues/known-issues-vs2013.md)


## Help us improve our documentation
Help us improve out docuementaiton by sending us a pull-request or opening a [GitHub Issue](https://github.com/Microsoft/cordova-docs/issues/new)

Expand Down
15 changes: 4 additions & 11 deletions known-issues/known-issues-general.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,29 +11,22 @@ This article covers general [known issues](../Readme.md#knownissues) related to
**Building a Cordova project from source control results in Cordova plugin APIs not returning results:** The following four json files can cause this to occur if added to source control.

- plugins/android.json
- plugins/ios.json
- plugins/windows.json
- plugins/remote_ios.json
- plugins/wp8.json.

Remove these files from source control if you are not checking in the "platforms" folder (reccomended). For local copies, you can either fetch a fresh copy from source control or remove the above files along with platforms found in the "platforms" folder to resolve the issue. See [tips and workarounds](../tips-and-workarounds/general/README.md#l#missingexclude) for additional details.

----------
**Plugin with variables not working:** Due to a Cordova issue with Cordova 4.3.0, you can run into problems with plugin variables in Cordova < 5.0.0. Plugin variable information is lost if you install the "plugin" before the "platform" which can happen depending on your workflow. They do, however, function in Cordova 5.1.1 which you can use with VS 2015. To update to 5.1.1 and use plugin variables, you will need to update your VS project and use the command line.
**Plugin with variables not working:** Due to a Cordova issue with Cordova 4.3.0 and 4.3.1, you can run into problems with plugin variables in Cordova < 5.0.0. Plugin variable information is lost if you install the "plugin" before the "platform" which can happen depending on your workflow. They do, however, function in Cordova 5.1.1 which you can use with VS 2015. Follow these steps to use a plugin with variables:

1. Remove the plugins with the variables via the config designer.

2. Update to Cordova 5.1.1 via the config designer (Platforms > Cordova CLI)

3. From the command line:
1. Go to your project directory.
2. Type the following from substituting project path, plugin name, and variables for those that apply to you:
~~~~~~~~~~~~~~
cd <project path>
npm install -g [email protected]
cordova plugin add nl.x-services.plugins.launchmyapp --variable URL_SCHEME=myscheme
~~~~~~~~~~~~~~

3. Re-add your plugin via "Plugins" tab in the config.xml designer

----------
**Slow first build or first plugin add:** The first build or plugin add for a given version of Cordova will be slower than subsequent builds as VS must first dynamically acquire Cordova. See the Output Window for more detail on progress. Further, the first remote iOS build will exhibit the same behavior as the agent downloads Cordova on your OSX machine. If you encounter a CordovaModuleLoadError with the first iOS build for a given Cordova version you can follow [these instructions](../tips-and-workarounds/ios/README.md#npm-cache) to resolve the problem.

Expand Down
14 changes: 13 additions & 1 deletion known-issues/known-issues-ios.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,18 @@
#**Known Issues - iOS**
This article covers [known issues](../Readme.md#knownissues) related to Visual Studio Tools for Apache Cordova 2015 when building or deploying to iOS devices or simulators.

----------
**vs-ms-remote reports a 404 error when using VS 2015 RTM or later:** VS 2015 RTM and up uses a new "remotebuild" agent instead of vs-mda-remote. See [remotebuild installation instructions](http://go.microsoft.com/fwlink/?LinkID=533745) for details.

----------
**iOS Simulator does not work when using the remotebuild agent and VS 2015 RTM:** You need to install version 3.1.1 of the ios-sim node module. Run "npm install -g [email protected]" from the Terminal app in OSX to install. See [remotebuild installation instructions](http://go.microsoft.com/fwlink/?LinkID=533745) for details.

----------
**iPhone 4S Simulator appears when selecting iPad or other device when using the remotebuild agent and VS 2015 RTM:** You need to install version 3.1.1 of the ios-sim node module. Run "npm install -g [email protected]" from the Terminal app in OSX to install. See [remotebuild installation instructions ](http://go.microsoft.com/fwlink/?LinkID=533745) for details.

----------
**Existing vs-mda-remote settings in Visual Studio do not work with the remotebuild agent:** You will need to generate and use a new PIN when setting up Visual Studio to connect to the remotebuild agent for the first time. If you are not using secure mode, turn secure mode on and then off again to cause VS to reinitalize. See [remotebuild installation instructions](http://go.microsoft.com/fwlink/?LinkID=533745) for details.

----------
**CordovaModuleLoadError from vs-mda-remote:** This error can occur if your ~/.npm folder or some of its contents were created while running as an administrator (sudo). To resolve, run the following commands after installing the latest version of the [vs-mda-remote package](https://www.npmjs.com/package/vs-mda-remote). These commands ensure your user has permissions to the contents of the npm package cache in your home directory when using older versions of Node.js and npm. Newer versions of Node.js and npm will do this for you automatically.

Expand Down Expand Up @@ -38,6 +50,6 @@ As a workaround, if you enter this state, soft reset your iOS device.
* [Download samples from our Cordova Samples repository](http://github.com/Microsoft/cordova-samples)
* [Follow us on Twitter](https://twitter.com/VSCordovaTools)
* [Visit our site http://aka.ms/cordova](http://aka.ms/cordova)
* [Read MSDN docs on using Visual Studo Tools for Apache Cordova](http://go.microsoft.com/fwlink/?LinkID=533794)
* [Read MSDN docs on using Visual Studio Tools for Apache Cordova](http://go.microsoft.com/fwlink/?LinkID=533794)
* [Ask for help on StackOverflow](http://stackoverflow.com/questions/tagged/visual-studio-cordova)
* [Email us your questions](mailto://[email protected])
14 changes: 3 additions & 11 deletions known-issues/known-issues-ripple-cordova.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,22 +5,14 @@ This article covers general [known issues](../Readme.md#knownissues) related to
**Cordova 5.x.x:** See [Cordova 5.x.x known issues](known-issues-cordova5.md) for details on Cordova and Ripple related issues that are specific to Cordova 5.0.0 and up.

----------
**Plugin with variables not working:** Due to a Cordova issue with Cordova 4.3.0, you can run into problems with plugin variables in Cordova < 5.0.0. Plugin variable information is lost if you install the "plugin" before the "platform" which can happen depending on your workflow. They do, however, function in Cordova 5.1.1 which you can use with VS 2015. To update to 5.1.1 and use plugin variables, you will need to update your VS project and use the command line.
**Plugin with variables not working:** Due to a Cordova issue with Cordova 4.3.0 and 4.3.1, you can run into problems with plugin variables in Cordova < 5.0.0. Plugin variable information is lost if you install the "plugin" before the "platform" which can happen depending on your workflow. They do, however, function in Cordova 5.1.1 which you can use with VS 2015. Follow these steps to use a plugin with variables:

1. Remove the plugins with the variables via the config designer.

2. Update to Cordova 5.1.1 via the config designer (Platforms > Cordova CLI)

3. From the command line:
1. Go to your project directory.
2. Type the following from substituting project path, plugin name, and variables for those that apply to you:
~~~~~~~~~~~~~~
cd <project path>
npm install -g [email protected]
cordova plugin add nl.x-services.plugins.launchmyapp --variable URL_SCHEME=myscheme
~~~~~~~~~~~~~~

3. Re-add your plugin via "Plugins" tab in the config.xml designer

----------
**TypeError: Request path contains unescaped characters:** When building or installing a plugin you may encounter this error if you are using a proxy with certain versions of Node.js and Cordova after a "npm http GET". This is a Cordova issue and the simplest workaround is to downgrade Node.js to 0.10.29. This will be resolved in a future version of Cordova. See [tips and workarounds](../tips-and-workarounds/general/README.md#cordovaproxy) for additional details.

Expand Down
13 changes: 13 additions & 0 deletions known-issues/known-issues-vs2015.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,18 @@ Lastly, you should add the following XML elements to your config.xml to ensure y
</platform>
~~~~~~~~~~~~~~~~~~~~~~

##Visual Studio 2015 RTM
----------
**vs-ms-remote reports a 404 error when using VS 2015 RTM or later:** VS 2015 RTM and up uses a new "remotebuild" agent instead of vs-mda-remote. See [remotebuild installation instructions](http://go.microsoft.com/fwlink/?LinkID=533745) for details.

----------
**iOS Simulator does not work when using the remotebuild agent and VS 2015 RTM:** You need to install version 3.1.1 of the ios-sim node module. Run "npm install -g [email protected]" from the Terminal app in OSX to install. See [remotebuild installation instructions](http://go.microsoft.com/fwlink/?LinkID=533745) for details.

----------
**iPhone 4S Simulator appears when selecting iPad or other device when using the remotebuild agent and VS 2015 RTM:** You need to install version 3.1.1 of the ios-sim node module. Run "npm install -g [email protected]" from the Terminal app in OSX to install. See [remotebuild installation instructions ](http://go.microsoft.com/fwlink/?LinkID=533745) for details.

**Existing vs-mda-remote settings in Visual Studio do not work with the remotebuild agent:** You will need to generate and use a new PIN when setting up Visual Studio to connect to the remotebuild agent for the first time. If you are not using secure mode, turn secure mode on and then off again to cause VS to reinitalize. See [remotebuild installation instructions](http://go.microsoft.com/fwlink/?LinkID=533745) for details.

##Visual Studio 2015 RC
----------
**VS 2015 RC and Cordova 5.x.x / Cordova Android 4.x.x:** See [Cordova 5.x.x known issues](known-issues-cordova5.md) for details on Android related issues that are specific to Cordova 5.0.0 and up.
Expand All @@ -118,6 +130,7 @@ To install updated plugins, follow [this proceedure to install a npm sourced plu
**Building a Cordova project from source control results in Cordova plugin APIs not returning results:** The following four json files can cause this to occur if added to source control.

- plugins/android.json
- plugins/ios.json
- plugins/windows.json
- plugins/remote_ios.json
- plugins/wp8.json.
Expand Down
Loading

0 comments on commit acab90f

Please sign in to comment.