magical_version_bump #

A command-line tool for changing/modifying the version specified in Flutter/Dart pubspec.yaml.

Table of Contents #

• Getting Started
• Executable Name
• Available Commands
• Basic Usage
• Available Flags
• Available Options
• Flag & Options in Command
• Default
• Known Caveats

Getting Started #

# 🎯 Activate it on your machine

dart pub global activate magical_version_bump

Overview #

magical_version_bump is a simple command-line tool. Use it to update your yaml files in your project ci or even locally. Check out our github action in the repository.

Executable Name #

Commands #

Basic Usage #

Usage of the CLI is easy and straight-forward.

# Check package version
$ mag -v

# Print help menu
$ mag -h

# Print command help menu
$ mag modify -h

$ mag change -h

Check example tab/folder for more.

Flags #

When using the modify command, flags are split into 2 categories:

• action - specifies whether to bump or dump the version by 1.
• target - specifies which specific SemVer version number you are targeting.

NOTE: Flags do not take in any value. They are passed in as is.

Options #

These, on the other hand, take in values you explicitly specify. When using options:

• Pass in a value using = sign. Like so: --option=value
• If the value has any spaces, enclose it with speech marks/double quotes. Like so : --option="my value with space"

Other useful options available include:

NOTE: yaml-version will be deprecated in favour of set-version in future release after v0.5.0.

Flags & Options in Commands #

Some flags/options can be used in both command while others cannot. Check table below.

Default #

• The tool will always check the current folder for the pubspec.yaml file. Add a --with-path flag to nudge the CLI to request the path from you.

mag modify -b --major --with-path # Requests path

mag modify -b --major --set-path=path-to-fil # Checks directory specified

# If set-path is used, with-path will be removed

• The tool will always do a relative versioning strategy. The collective version will be bumped up/down based on the position of the version passed in. This is the default versioning recommended by Dart & SemVer.

mag modify --bump --major # Bumps version 1.1.1 to 2.0.0

mag modify --bump --minor # Bumps version 1.1.1 to 1.2.0

mag modify --bump --patch # Bumps version 1.1.1 to 1.1.2

• The tool allows for various versions to be modified simultaneously. If more than one version target is passed in, version with the highest weight will be used to relatively bump up the collective version.
  • major - 20
  • minor - 10
  • patch - 5
  • build-number - 0

mag modify --bump --major --minor --patch 

# Bumps version 1.1.1 to 2.0.0
# major version has the highest weight

• If you need each version to be bumped independently, pass in the --absolute flag.

mag modify --bump --major --minor --patch --absolute

# Bumps version 1.1.1 to 2.2.2

• If you pass in set-version when using modify command, the version will be updated before any other action is performed on the version.

# Initial version was 2.3.4

mag modify --set-version=8.8.8 --bump major

# Version 2.3.4 updated to 8.8.8 first.
# Version 8.8.8 then bumped to 9.0.0

• Using set-version also removes the build metadata and any prerelease info in the version. Pass in --keep-build or --keep-pre to keep desired data

# Initial version was 2.3.4-alpha+22

mag modify --set-version=8.8.8

# Final version will be 8.8.8

mag modify --set-version=8.8.8 --keep-build --keep-pre

# Final version will be 8.8.8-alpha+22

Known Caveats #

• Cannot bump prerelease or custom build numbers. To work around this, consider using set-prerelease or set-build.

If you notice any more issue, please do raise them. Hope you like the package!