Skip to content
unlock

GitHub Action

Setup Pub.dev credentials

v1.0 Latest version

Setup Pub.dev credentials

unlock

Setup Pub.dev credentials

Configuring credentials for automated publishing of packages to pub.dev

Installation

Copy and paste the following snippet into your .yml file.

 
              
- name: Setup Pub.dev credentials

              
  uses: flutter-actions/[email protected]
Learn more about this action in flutter-actions/setup-pubdev-credentials

Choose a version

About

GitHub Action to configuring credentials for automated publishing of packages to pub.dev

When configuring automated publishing you don't need to create a long-lived secret that is copied into your automated deployment environment. Instead, authentication relies on temporary OpenID-Connect tokens signed by GitHub Actions.

See Automated publishing of packages to pub.dev and OpenID Connect allows your workflows to exchange short-lived tokens directly from your cloud provider for more information.

Usage

# .github/workflows/publish.yml
name: Publish to pub.dev

on:
  push:
    tags:
    - 'v[0-9]+.[0-9]+.[0-9]+*' # tag pattern on pub.dev: 'v{{version}'

# Publish using custom workflow
jobs:
  publish:
    permissions:
      id-token: write # Required for authentication using OIDC
      content: read
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      # Setup Flutter SDK and automated pub.dev credentials
      - uses: flutter-actions/setup-flutter@v3
      - uses: flutter-actions/setup-pubdev-credentials@v1

      - name: Install dependencies
        run: flutter pub get
      # Here you can insert custom steps you need
      # - name: Build
      #   run: flutter build ...
      - name: Publish
        run: flutter pub publish --force

License

Licensed under the MIT License.