From 07a654e7717a20d685c3eadf4b55c2e6731e96fa Mon Sep 17 00:00:00 2001 From: Tony Date: Thu, 25 Jun 2026 20:06:50 +0800 Subject: [PATCH] Default CLI to open infrastructure --- OPEN_SOURCE_REPLACEMENTS.md | 2 +- README.md | 25 +++++++++------------- third_party/flutter/bin/internal/shared.sh | 2 +- 3 files changed, 12 insertions(+), 17 deletions(-) diff --git a/OPEN_SOURCE_REPLACEMENTS.md b/OPEN_SOURCE_REPLACEMENTS.md index 940bd90e..725674e9 100644 --- a/OPEN_SOURCE_REPLACEMENTS.md +++ b/OPEN_SOURCE_REPLACEMENTS.md @@ -48,7 +48,7 @@ are configured to use local/self-hosted origins when no override is supplied: | API/auth server | `http://localhost:8080` | | OpenAPI contract | `http://localhost:8080/openapi.yaml` and `../shorebird-server/internal/api/handlers/openapi.yaml` | | CLI patch-tool artifact mirror | `http://localhost:8080/artifacts` | -| Flutter engine/Maven artifact mirror | `http://localhost:8080/download.flutter.io` | +| Flutter engine/Dart SDK/Maven artifact mirror | `http://localhost:8080/download.flutter.io` | | Web console | self-hosted `shorebird-server/web` dashboard | Override these values with `SHOREBIRD_HOSTED_URL`, diff --git a/README.md b/README.md index ad6767ec..e05dc6ad 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,14 @@ -## Shorebird 🐦 +## Shorebird -[![Discord](https://img.shields.io/discord/1030243211995791380?style=for-the-badge&logo=discord&color=blue)](https://discord.gg/shorebird) -Shorebird Code Push - Flutter over the air updates | Product Hunt - -[![shorebird ci](https://api.shorebird.dev/api/v1/github/shorebirdtech/shorebird/badge.svg)](https://console.shorebird.dev/ci) -[![ci](https://github.com/shorebirdtech/shorebird/actions/workflows/main.yaml/badge.svg)](https://github.com/shorebirdtech/shorebird/actions/workflows/main.yaml) -[![e2e](https://github.com/shorebirdtech/shorebird/actions/workflows/e2e.yaml/badge.svg)](https://github.com/shorebirdtech/shorebird/actions/workflows/e2e.yaml) -[![codecov](https://codecov.io/gh/shorebirdtech/shorebird/branch/main/graph/badge.svg)](https://codecov.io/gh/shorebirdtech/shorebird) [![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE-MIT) [![License: Apache](https://img.shields.io/badge/license-Apache-orange.svg)](./LICENSE-APACHE) ## Getting Started -Visit https://docs.shorebird.dev to get started. +This fork is wired for the open workspace CI and self-hosted services described +in [OPEN_SOURCE_REPLACEMENTS.md](OPEN_SOURCE_REPLACEMENTS.md). The root +workspace workflow, `.github/workflows/open-shorebird-ci.yml`, builds the open +CLI, server, updater patch tools, custom Dart SDK, and engine artifacts. ## Packages @@ -35,8 +31,8 @@ For more information, please refer to the documentation for each package. ## Contributing -If you're interested in contributing, please join us on -[Discord](https://discord.gg/shorebird). +If you're interested in contributing, use this fork's issue tracker or the root +workspace documentation. ### Environment setup @@ -79,7 +75,8 @@ The following command will generate a coverage report for the Dart packages: dart test --coverage=coverage && dart pub global run coverage:format_coverage --lcov --in=coverage --out=coverage/lcov.info --packages=.dart_tool/package_config.json --check-ignore ``` -Coverage reports are uploaded to [Codecov](https://app.codecov.io/gh/shorebirdtech/shorebird). +Coverage reports are generated locally under `coverage/`. Configure upload for +your own mirror or CI account when publishing this fork. ## License @@ -87,6 +84,4 @@ Shorebird projects are licensed for use under either Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0) MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT) at your option. -See our license philosophy for more information on why we license files this -way: -https://handbook.shorebird.dev/engineering/#licensing-philosophy +See the Apache and MIT license files in this repository for the license terms. diff --git a/third_party/flutter/bin/internal/shared.sh b/third_party/flutter/bin/internal/shared.sh index dfffafef..6c84955a 100755 --- a/third_party/flutter/bin/internal/shared.sh +++ b/third_party/flutter/bin/internal/shared.sh @@ -219,7 +219,7 @@ function shared::execute() { >&2 echo "Error: The shorebird directory is not a clone of the GitHub project." >&2 echo " The shorebird tools requires Git in order to operate properly;" >&2 echo " to install Shorebird, see the instructions at:" - >&2 echo " https://github.com/shorebirdtech/shorebird" + >&2 echo " https://git.tonycloud.org/flutter/shorebird" exit 1 fi