search

k-paxian / dart-package-publisher

Action to Publish Dart / Flutter Package To https://pub.dev When you need to publish a package, just bump the version in pubspec.yaml
MIT License
66 stars 10 forks source link

Don't use the "name" input field, instead create a separate one #3

Closed pavanpodila closed 4 years ago

pavanpodila commented 4 years ago

This is more of an aesthetic suggestion but can greatly improve the usability of the action when viewing the progress on the Actions page of Github.

Instead of relying on the name field for the package name, use a separate field, say packageName to capture the name of the package. The name field is used by Github to print the name of the action, which is a more user-friendly way of reading the step.

image

Notice in the above picture, the name of the package is the only one that shows up, which makes it difficult to know what the step is doing.

k-paxian commented 4 years ago

You can completely omit the name yourself, it's totally up to you to use it. like this will work as well:

  - uses: k-paxian/dart-package-publisher@master
    with:
      accessToken: ${{ secrets.OAUTH_ACCESS_TOKEN }}
      refreshToken: ${{ secrets.OAUTH_REFRESH_TOKEN }}

If you want to describe this step put a descriptive name

  - name: '>> Publish My Dart package <<'
    uses: k-paxian/dart-package-publisher@master
    with:
      accessToken: ${{ secrets.OAUTH_ACCESS_TOKEN }}
      refreshToken: ${{ secrets.OAUTH_REFRESH_TOKEN }}