Skip to content

Latest commit

 

History

History
206 lines (134 loc) · 7.27 KB

README.md

File metadata and controls

206 lines (134 loc) · 7.27 KB
Raw

Cap Sync Version (CLI)

This CLI syncs the npm package version to the capacitor android and ios projects.

Github: https://github.com/bjesuiter/capacitor-sync-version-cli

Capacitor creates a folder for each platform in the root of your project, like android, ios, and electron. Since electron is in beta right now, it's not supported by this tool.

Capacitor does not deal with syncing the version number from your package.json to the mobile projects, mainly because this sync is not 1 to 1 possible without assumtions. This cli uses an automatic alogrithm to calculate the android versionCode based on the version string from package.json. The android versionCode is an ever increasing integer-32 defining the unique version for each app.

Install

npm i cap-sync-version

Android Notes

In Android the plugin will automatically make the following modifications:

  1. Add the following after apply plugin: 'com.android.application' at the top of ./android/app/build.gradle:

    def appProperties = new Properties();
file("app.properties").withInputStream { appProperties.load(it) }

  2. Use these new properties to set versionCode and versionName in ./android/app/build.gradle

    defaultConfig {
    versionCode appProperties.getProperty('versionCode').toInteger()
    versionName appProperties.getProperty('versionName')
}

  3. Create a file called app.properties under ./android/app/ with the following two properties to the file:

    versionName: 0.0.1
versionCode: 1

    Note: These values will be overwritten with the next call to this cap-sync-version cli.

iOS Notes

Nothing to say

CLI Usage

$> cap-sync-version --help

Usage: cap-sync-version [options]

Options:
  -v, --version                   output the version number
  -a, --android                   Sync package version to android. It will not update iOS, unless --ios is specified. (default: false)
  -p, --android-allow-prerelease  Note: This flag is disabled since 2.0.0 and will be ignored, because it produced unrelieable version codes in android.  (default: false)
  -i, --ios                       Sync package version to ios.  It will not update Android, unless --android is specified. (default: false)
  -plist, --plist [files...]      Add additional plists to modify (ios only) (default: false)
  -h, --help                      display help for command

  General Information:
            Version: 2.0.2
            Purpose: This CLI syncs the npm package version to the capacitor android and ios projects.
            Default Behavior: syncs the package version to android and ios, if available

Credits

Big Thanks for Contributions to

Package created after:
https://medium.com/netscape/a-guide-to-create-a-nodejs-command-line-package-c2166ad0452e

Pure ESM Package modeled after:
Sindre Sorhus - Pure ESM Package

Changelog

All notable changes to this project will be documented here. The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

3.1.1 - 2023-07-15

  • Add Github link to Readme

3.1.0 - 2023-07-15

  • Now the android updater will make the necessary changes in the gradle file automatically instead of leaving it as a manual process for the user of this package. Note: If something breaks because of this, open an Issue or even a PR with a fix at: https://github.com/bjesuiter/capacitor-sync-version-cli

v3.0.7 - 2023-07-12

  • Update Dependencies:

    • Commander to ^11.0.0
    • fs-extra to ^11.1.1
    • read-pkg to ^8.0.0

v3.0.6 - 2023-05-23

  • Update npm shield in readme to be able to click on it to come to npm

v3.0.5 - 2023-05-22

  • Add install instructions to Readme
  • Fix an import bug with readPackageAsync

v3.0.3 & v3.0.4 - 2021-02-19

  • Update Dependencies (see exact commits at the end of this github release)
  • Note: 3.0.4 has this changelog published to npm (missing in 3.0.3)

v3.0.2 - 2021-07-10

  • Update Dependencies:

    • commander to 8.0.0
    • some npm audit fix updates
    • xo linting package

  • includes PR 13 by Lucas Zeer

    • fixes commander 7.X options handling change (new: cli.opts property)
    • fixes handling of default plattforms to update npm version for

v3.0.1 - 2021-05-29

  • Fixed Version Numbers in Changelog for 3.0.0 & 3.0.1

v3.0.0 - 2021-05-29

  • Contribution by Lucas Zeer: Possibility to add additional Plist files on iOS as targets for version sync
  • BREAKING CHANGE: This CLI is now a pure ESM Package, which means, it needs NodeJS > 12.20 to run (see 'engines' field in package.json for more details)
  • Updated all dev & normal dependencies to fix security problems
  • fix version reporting for cap-sync-version cli

2.0.3 & 2.0.4 - 2020-04-24

  • Update readme

2.0.2 - 2020-04-24

  • Add tests for buildAndroidVersionCode function to make sure all android version code generation works correctly and especially continuously

2.0.1 - 2020-04-24

  • Updates for Readme & Changelog

2.0.0 - 2020-04-24

  • prohibit generating versions with prerelease part
  • removes all code for prerelease versionCode generation for android to avoid instabilities in the version code

1.0.1 - 2020-04-22

  • Improve Badges in Readme

1.0.0 - 2020-04-22 - Initial Release

  • Feature: ability to sync versions of android and ios capacitor projects with the npm package version

0.0.0 - 2020-04-22 - Initial Package Version

Initial Package Creation

FAQ

Why is there no prerelease support on android anymore since version 2.0?

Note: Periods in example android version codes are for better readability

  1. A version of 2.3.5-0 would have a version code of 2.030.500 and the version 2.3.5 would also have the version code 2.030.500, since the prerelease digits are zero per default.
  2. A version of 2.3.5-1 would have a higher version code as 2.3.5, even though 2.3.5 is the final version of 2.3.5-1. Version 2.3.5-1 would have the code 2.030.501, but version 2.3.5 would have the code 2.030.500, which would result in rejection of the built apk or aab by the google play console.
  3. iOS is not able to encode prerelease versions like this altogether.

One could fix above errors, but not without making the version generation algorithm more complicated and less intuitive. And when looking at the fact, that iOS doesn't even support prerelease versions, I'll simply increase the headroom of patch versions (where the developer can decide to mark them as beta or something).