Dart Pub Publish
We use this workflow to publish a Dart package to pub.dev.
Steps
The Dart Pub Publish workflow consists of the following steps:
- Install dependencies
- Setup pub credentials
- Dry run
- Publish
Inputs
dart_sdk
Optional Which Dart SDK version to use. It can be a version (e.g. 3.5.0
) or a channel (e.g. stable
):
Default "stable"
working_directory
Optional The path to the root of the Dart package.
Default "."
runs_on
Optional An optional operating system on which to run the workflow.
Default "ubuntu-latest"
Secrets
pub_credentials
Required The pub credentials needed for publishing. This can be retrieved by reading out your pub-credentials.json
on your system after you ran a dart pub login
, the location of the file is different per operating system:
OS | Path |
---|---|
Linux | $XDG_CONFIG_HOME/dart/pub-credentials.json or $HOME/.config/dart/pub-credentials.json |
macOS | ~/Library/Application\ Support/dart/pub-credentials.json |
Windows | %APPDATA%/dart/pub-credentials.json |
Example Usage
We recommend using GitHub Secrets for safely storing and reading the credentials.
name: My Dart Pub Publish Workflow
on: pull_request
jobs:
build:
uses: VeryGoodOpenSource/very_good_workflows/.github/workflows/dart_pub_publish.yml@v1
with:
dart_sdk: 'stable'
working_directory: 'packages/my_dart_package'
secrets:
pub_credentials: secrets.PUB_CREDENTIALS