Creating a release

📁

pub_release

Search…

📁

pub_release

README

Creating a release

Multi-package Releases

Hooks

Dependency overrides

Automatic github releases

Attach an asset to a github release

Automating releases using Git work flows

Version File

CHANGELOG

example

Creating a release

To update the version no. and publish your project run:
1
pub_release
Copied!
The pub_release command will:
prompt you to select the new version number
update pubspec.yaml with the new version no.
create/update a version file in src/util/version.g.dart
format your code with dartfmt
analyze you code with dartanalyzer
Generate a default change log entry using your commit history
Allow you to edit the resulting change log.
push all commits to git
run any scripts found in the pre_release_hook directory.
remove and restore any dependency overrides in your pubspec.yaml
publish your project to pub.dev
run any scripts found in the post_release_hook directory.
--dry-run
You can pass the --dry-run flag on the pub_release command line. In this case the pub_release process is run but no modifications are made to to the project (except for code formatting). The dart pub publish command is also run with the --dry-run switch so suppress publishing the package.
setVersion
--[no]-test
You can pass a version no. as an option on the command line. By default Pub Release will prompt the user for a new version no. When you pass the setVersion option the user will not be prompted and the passed version will be used.
By default pub-release will run all unit tests (via the critical_test package) before doing a release.
1
pub_release --setVersion=2.2.1
Copied!
If any unit tests fail then the release will be halted.
autoAnswer
You can by pass the running of unit tests by passing the --no-test flag on the command line.
By default Pub Release runs in interactive mode and will ask the users a no. of questions during the release process. You can suppress these questions by passing the --autoAnswer flag. When you pass the autoAnswer flag Pub Release assumes that you answer yes to all questions and takes the default path.
--[no]-git
1
pub_release --autoAnswer
Copied!
By default pub_release detects if your code is managed by git.
test
If the code is managed by git then it will automatically commit any changes made during the release process as well as creating a release tag.
The --test flag instructs Pub Release to run all unit tests using the Critical Test package. If any test fails the release will be aborted.
You can suppress all git operations by passing the --no-git flag.
1
pub_release --test
Copied!
Note: git operations are only supported against github. If you remote git repo is other than github then you should always use the --no-git flag.
line
pub_release will work if you just have a local git repo with no remote set.
The line flag controls the line length of Dart libraries when formatting code. The line length defaults to 80 characters.
--autoAnswer
1
pub_release --line=120
Copied!
If you pass the --autoAnswer flag then the user will no be prompted during the release process.
multi
If you use the --autoAnswer flag you MUST also pass the --setVersion flag.
The multi flag performs a simultaneous release of multiple related packages.
--setVersion
See multi-package releases for details.
The --setVersion option allows you to set the version from the command line.
If the --setVersion option isn't passed then you will be prompted to select the version no.
--line
The --line option allows you to override the default line width (80) used when formatting code.
We recommend that you use the dart default width of 80.
--tags
By default pub_release runs every test that is not marked as 'skipped'.
You can limit the set of test by passing in the --tag option.
1
pub_release --tag='OnlyTheGoodOnes'
Copied!
See the test guide for details on how to setup and select tests via tags.
--exclude-tags
By default pub_release runs every test that is not marked as 'skipped'.
You can exclude certain tests by passing in the --exclude-tags option.
​
1
pub_release --exclude-tags='slow'
Copied!
See the test guide for details on how to setup and exclude tests via tags.
--multi
Performs a multi-package release.
Use the --multi flag when you have multiple related packages that need to be released in sync with a single version no.

README

Multi-package Releases

Last modified 7mo ago

Copy link

Contents