Skip to content

Latest commit

 

History

History
153 lines (100 loc) · 3.79 KB

README.md

File metadata and controls

153 lines (100 loc) · 3.79 KB
Raw

nativescript-set-version

License: MIT

This tool allows you to easily update the version of a Nativescript application. It will update the following files if found:

  • ./package.json
  • ./app/App_Resources/Android/src/main/AndroidManifest.xml
  • ./app/App_Resources/Android/app/app.gradle
  • ./app/App_Resources/iOS/Info.plist

Version number format

In order to use this package, your project version must comply with the format described on semver.org.

Setup and Usage

There are two ways to install nativescript-set-version: globally and locally.

Local Installation

This is the recommended way to install nativescript-set-version.

npm:

npm install nativescript-set-version --save-dev

yarn:

yarn add nativescript-set-version --dev

You can then use this command in your project directory to run nativescript-set-version:

npm:

$ npm run setVersion <version>
-- or --
$ npm run set-version <version>

yarn:

$ yarn setVersion <version>
-- or --
$ yarn set-version <version>

Global Installation

This installation method allows you to use nativescript-set-version in any project.

npm:

npm install -g nativescript-set-version

yarn:

yarn global add nativescript-set-version

You can then use this command in your project directory to run nativescript-set-version:

setVersion <version>
-- or --
set-version <version>

Behaviour

When invoked, nativescript-set-version will make the following changes to your project files:

Update Package Version

The version attribute in package.json will be updated with the specified version.

Update Android Project Version

It will update the version name and the version code in both app.gradle and AndroidManifest.xml.

About AndroidManifest.xml

Version information should not be in the AndroidManifest.xml since this information is overridden by app.gradle.

See https://developer.android.com/studio/publish/versioning for further informations.

For that reason nativescript-set-version will only write in the AndroidManifest.xml if android:versionCode and/or android:versionName are already in the file.

Update iOS Project Version

It will update the CFBundleShortVersionString and the CFBundleVersion in Info.plist.

How the version code and CFBundleVersion are updated

The Android version code represents your version number as an integer. This package uses the following format to generate this integer:

<MAJOR><MINOR ON 2 DIGITS><PATCH ON 2 DIGITS><BUILD NUMBER>

For instance, the first time you call set-version 3.1.4, it will produce the version code 301041.

If you call the command with the same version a second time, it will increment the build number, to produce 301042.

This also applies if, for instance, you call set-version 3.1.4-rc.1, and then set-version 3.1.4-rc.2.

As for the CFBundleVersion on iOS, it will produce a string in the format <MAJOR>.<MINOR>.<PATCH>.<BUILD NUMBER>.

Example:

$ yarn set-version 1.0.0-rc.1
# Output
# ...
# Will set android version code to 100001
# ...
# Will set CFBundleVersion to 1.0.0.1
$ yarn set-version 1.0.0-rc.2
# Output
# ...
# Will set android version code to 100002
# ...
# Will set CFBundleVersion to 1.0.0.2
$ yarn set-version 1.0.0
# Output
# ...
# Will set android version code to 100003
# ...
# Will set CFBundleVersion to 1.0.0.3

License

This software uses the MIT license.

Contributing

You must use the following style guide:

This project contains a linting config, you should setup eslint into your IDE with .eslintrc.js.