This is a tool to automate publishing of pub packages from GitHub actions.
When run from a PR, this tool will validate the package pubspecs and changelogs and indicate whether the criteria for publishing has been met. Generally, each PR should add a new entry to the changelog, rev the pubspec version, and the changelog version and pubspec version should agree.
When run in response to a git tag event (a tag with a pattern like v1.2.3
or name_v1.2.3
for monorepos), this tool will publish the indicated package.
Pre-release versions (aka, '1.2.3-dev'
) are handled specially; this tool will validate the package but will not auto-publish it. This can be used to accumulate several changes and later publish them as a group.
In order to disable package validation and auto-publishing, add the publish_to: none
key to your pubspec.
For PRs, this tool:
dart pub publish --dry-run
In response to a git tag event, this tool:
dart pub publish --force
)This tool can work with either single package repos or with mono-repos (repos containing several packages). It will scan for and detect packages in a mono repo; to omit packages from validation and auto-publishing, add a publish_to: none
key to its pubspec.
For single package repos, the tag pattern should be v1.2.3
. For mono-repos, the tag pattern must be prefixed with the package name, e.g. foo-v1.2.3
.
.github/workflows/publish.yaml
file in your repomain
)tags: [ '[A-z]+-v[0-9]+.[0-9]+.[0-9]+*' ]
# A CI configuration to auto-publish pub packages. name: Publish on: pull_request: branches: [ main ] push: tags: [ 'v[0-9]+.[0-9]+.[0-9]+*' ] jobs: publish: uses: dart-lang/ecosystem/.github/workflows/publish.yaml@main
Callers may optionally specify the version of the SDK to use when publishing a package. This can be useful if your package has a very recent minimum SDK constraint. This is done via the sdk
input parameter. Note that this parameter is not required; it defaults to stable
- using the most recent stable release of the Dart SDK. To pass this value:
jobs: publish: uses: dart-lang/ecosystem/.github/workflows/publish.yml@main with: sdk: beta
The description of the common workflow for repos using this tool can be found at https://github.com/dart-lang/ecosystem/wiki/Publishing-automation.