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
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.
.github/workflows/publish.yamlfile in your repo
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 ] types: [opened, synchronize, reopened, labeled, unlabeled] push: tags: [ 'v[0-9]+.[0-9]+.[0-9]+' ] jobs: publish: uses: dart-lang/ecosystem/.github/workflows/publish.yaml@main
with: write-comments: false
.github/workflows/post_summaries.yamlfile in your repo
# A CI configuration to write comments on PRs. name: Comment on the pull request on: workflow_run: workflows: - Publish types: - completed jobs: upload: uses: dart-lang/ecosystem/.github/workflows/post_summaries.yaml@main permissions: pull-requests: write
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
Callers may optionally specify the name of a github environment for the publish job to use. This is useful if you want to require approvals for the publish job to run. To pass this value:
jobs: publish: uses: dart-lang/ecosystem/.github/workflows/publish.yml@main with: environment: pub.dev # Can be any name, this is the convention though.
Make sure to also require this environment to be present in your package admin settings. See the pub.dev documentation on this.
The description of the common workflow for repos using this tool can be found at https://github.com/dart-lang/ecosystem/wiki/Publishing-automation.
This is a Github workflow to check PR health.
When run from a PR, this tool will check a configurable subset of the following
.dartfiles have a license header.
This tool can work with either single package repos or with mono-repos (repos containing several packages).
.github/workflows/health.yamlfile in your repo
name: Health on: pull_request: branches: [ main ] types: [opened, synchronize, reopened, labeled, unlabeled] jobs: health: uses: dart-lang/ecosystem/.github/workflows/health.yaml@main # with: # checks: "version,changelog,license,coverage"
The description of the common workflow for repos using this tool can be found at https://github.com/dart-lang/ecosystem/wiki/Pull-Request-Health.