Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .github/workflows/check-code-quality.yml
Original file line number Diff line number Diff line change
@@ -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"]
Expand Down
4 changes: 3 additions & 1 deletion .github/workflows/create-git-tags-for-publishing.yml
Original file line number Diff line number Diff line change
@@ -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:

Expand Down
2 changes: 2 additions & 0 deletions .github/workflows/publish-package.yml
Original file line number Diff line number Diff line change
@@ -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:

Expand Down
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

</div>

`WidgetDriver` is a Flutter presentation layer framework,
Expand All @@ -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)

Expand All @@ -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.
Expand Down Expand Up @@ -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.