diff --git a/docs/VERSIONING.md b/docs/VERSIONING.md index 4ca8df6..855d33b 100644 --- a/docs/VERSIONING.md +++ b/docs/VERSIONING.md @@ -1,63 +1,14 @@ # Versioning the App -Versioning the app needs to be a manual step. Follow the instructions below to update the versions +Versioning the app will be done with [npm-version](https://docs.npmjs.com/cli/v6/commands/npm-version). Please follow the instructions to +create a proper update and run the command -## Table of contents -1. [Versioning project](#versioning-project) -1. [Versioning iOS](#versioning-ios) -1. [Versioning Android](#versioning-android) -1. [When done](#when-done) + yarn version patch | minor | major + +It will then automatically update Git, see [this](https://github.com/saucelabs/sample-app-mobile/commit/f61d8fec2b17b233d0abd8444fe0f0dc86a1d7db) commit for an example. -## Versioning project -Open the `package.json` and update the version to the version you need, try to use [SEMVER](https://nodesource.com/blog/semver-a-primer/), meaning using this +Then: - x.y.z - -- `x`: This is a `MAJOR` release, there are for example breaking changes -- `y`: This is a `MINOR` release and can hold for example new features -- `z`: This is a `PATCH` release which holds fixes - - -## Versioning iOS -Open the following file [`ios/SwagLabsMobileApp/Info.plist`](../ios/SwagLabsMobileApp/Info.plist) and change this code - -``` -CFBundleShortVersionString -1.0.0 -CFBundleSignature -???? -CFBundleVersion -1 -``` - -To this - -``` -CFBundleShortVersionString -x.y.z -CFBundleSignature -???? -CFBundleVersion -{current value + 1} -``` - -Open the following file [`ios/SwagLabsMobileApp.xcodeproj/project.pbxproj`](../ios/SwagLabsMobileApp.xcodeproj/project.pbxproj) -and change all `CURRENT_PROJECT_VERSION = 1;` to `CURRENT_PROJECT_VERSION = {current value + 1};` - -## Versioning Android -Open the following file [`android/app/build.gradle`](../android/app/build.gradle) and change this code - -``` -versionCode 1 -versionName "1.0.0" -``` - -to - -``` -versionCode {current value + 1} -versionName "x.y.z" -``` - -## When done -When all changes are executed create a feature branch and a PR +- build the apps +- create a new release on Git +- upload the apps to Git