diff --git a/.github/workflows/check-code-quality.yml b/.github/workflows/check-code-quality.yml index 047fba6..5809d56 100644 --- a/.github/workflows/check-code-quality.yml +++ b/.github/workflows/check-code-quality.yml @@ -1,4 +1,6 @@ name: check-code-quality +# This workflow checks the code quality of the Flutter project. +# It is triggered on push and pull request events to the master branch when ready-for-pipeline label is set. on: push: branches: ["master"] diff --git a/.github/workflows/create-git-tags-for-publishing.yml b/.github/workflows/create-git-tags-for-publishing.yml index 88a619b..61f65a3 100644 --- a/.github/workflows/create-git-tags-for-publishing.yml +++ b/.github/workflows/create-git-tags-for-publishing.yml @@ -1,4 +1,6 @@ -name: Publish all packages to pub.dev +name: Create Git Tags for Publishing +# This workflow creates git tags for each package in the repository. +# It is triggered manually via the GitHub Actions UI. on: workflow_dispatch: diff --git a/.github/workflows/publish-package.yml b/.github/workflows/publish-package.yml index 9912485..ea5a937 100644 --- a/.github/workflows/publish-package.yml +++ b/.github/workflows/publish-package.yml @@ -1,4 +1,6 @@ name: Publishes a package specified by the git tag to pub.dev +# This workflow publishes a package to pub.dev when a git tag is created. +# It is triggered manually via the GitHub Actions UI. on: workflow_dispatch: diff --git a/README.md b/README.md index 7e8fa28..46f0da5 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,7 @@ [![check-code-quality](https://github.com/bmw-tech/widget_driver/actions/workflows/check-code-quality.yml/badge.svg?branch=master)](https://github.com/bmw-tech/widget_driver/actions/workflows/check-code-quality.yml) [![License](https://img.shields.io/badge/license-MIT-purple.svg)](LICENSE) + `WidgetDriver` is a Flutter presentation layer framework, @@ -16,7 +17,7 @@ The `WidgetDriver` framework is built up on different dart packages. The core pa Here is an overview of all the packages: -## widget_driver [![pub package](https://img.shields.io/pub/v/widget_driver.svg)](https://pub.dev/packages/widget_driver) +## widget_driver [![pub package](https://img.shields.io/pub/v/widget_driver.svg)](https://pub.dev/packages/widget_driver) - [Source code](widget_driver) @@ -36,7 +37,7 @@ Import it into your pubspec `dev_dependencies:` section. - [Source code](widget_driver_annotation) -The annotation package which has no dependencies. +The annotation package which has no dependencies. You do not need to import this since the `widget_driver` package already imports it for you. But if you need/want to import it then import it into your pubspec `dependencies:` section. @@ -91,4 +92,6 @@ watch Starts the example app and performs the hot reload i ### Publish to pub.dev -To make the plugins accessible, we want to publish them to pub.dev. [publish_all_packages.yml](.github/workflows/publish_all_packages.yml) contains a job that deploys all four plugins to pub.dev. This job is named `Publish all packages to pub.dev` and is triggered manually. If you want to check first if it's safe to publish the plugins, you can run `dart pub publish --dry-run` in the root of each plugin. +To make the plugins accessible, we plan to publish them to pub.dev. The first step in this process is to create Git tags, which is required for publishing. This can be done by triggering the [create-git-tags-for-publishing.yml](.github/workflows/create-git-tags-for-publishing.yml) workflow. This action generates Git tags for all packages in the repository + +The second step is to publish the tagged packages to pub.dev, which can be done by triggering the [publish-package.yml](.github/workflows/publish-package.yml) workflow.