Skip to content

README.md

Latest commit

 

History

History
109 lines (70 loc) · 2.29 KB

README.md

File metadata and controls

109 lines (70 loc) · 2.29 KB

Scripts Setup

Git Hooks

  • Run the following command to make the setup-hooks script executable
chmod +x ./scripts/setup-hooks.sh
  • Then run the setup-hooks script. This will setup the git hooks.
./scripts/setup-hooks.sh

Development Scripts

These are the scripts that you will run manually during development.

Make sure you have run flutter pub get before running these commands.

If you get on Mac while running below scripts zsh: permission denied: run following command,

 chmod +x scripts/*.sh

Build Runner

Run the following command to trigger build for all generated dart files.

scripts/build-runner.sh

Generate All

This will generate all dart files. It basically runs build runner and generate classes

scripts/generate-all.sh

Run

Run the app on a device or an emulator.

scripts/run.sh [flavor] [--build-type]
  • flavor: dev, qa, prod
  • build-type: debug, profile, release. Defaults to debug. Example:
scripts/run.sh dev --debug

Build

scripts/build.sh [file-format] [flavor] [--build-type] [--additional-flag]
  • file-format: apk, appbundle, ios.
  • flavor: dev, qa, prod.
  • build-type: debug, profile, release. Defaults to debug.
  • additional-flag: Any addition flag to pass to the flutter build command. Defaults to no flag. Example:
scripts/build.sh ios prod --release --no-codesign

Device Preview

Runs the flutter app's dev flavor with the device preview package enabled. Device preview let's you test how an app will look on various devices, orientations, etc.

scripts/device-preview.sh

Github Action Scripts

These scripts are used by github actions CI/CD.

Bump Build Number

Bumps the versionCode/buildNumber by 1 in pubspec.yaml file. For example, it will change version: 1.2.5+12 to version: 1.2.5+13.

scripts/bump-build-number.sh

Set Current Version to ENV

Sets the current version from pubspec.yaml to the github actions environment variables.

scripts/gh-action-read-and-set-version-env.sh

Commit Version

Reads the version from pubspec.yaml and creates a commit with the message "Bump version to ( version)". Then push the change to the current branch.

scripts/commit-version.sh