From 46f5ddd9a47ee6ff196719a0602d83d66b5110d6 Mon Sep 17 00:00:00 2001 From: Tibor Bodecs Date: Wed, 4 Feb 2026 11:43:50 +0100 Subject: [PATCH 1/3] fix version in md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 0861854..41ea43e 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ Abstract database component, providing a shared API surface for database drivers written in Swift. [ - ![Release: 1.0.0-beta.3](https://img.shields.io/badge/Release-1%2E0%2E0--beta%3E2-F05138) + ![Release: 1.0.0-beta.3](https://img.shields.io/badge/Release-1%2E0%2E0--beta%2E3-F05138) ]( https://github.com/feather-framework/feather-database/releases/tag/1.0.0-beta.3 ) From cc3beeb9e801ea3fd7d5b3f393897fc83fbc176b Mon Sep 17 00:00:00 2001 From: GErP83 Date: Wed, 4 Feb 2026 15:00:42 +0100 Subject: [PATCH 2/3] change make, fix readme --- Makefile | 5 ++++- README.md | 46 ++++++++++++++++++---------------------------- 2 files changed, 22 insertions(+), 29 deletions(-) diff --git a/Makefile b/Makefile index a3e1b32..6eb7b96 100644 --- a/Makefile +++ b/Makefile @@ -2,7 +2,10 @@ SHELL=/bin/bash baseUrl = https://raw.githubusercontent.com/BinaryBirds/github-workflows/refs/heads/main/scripts -check: symlinks language deps lint headers +check: symlinks language deps lint headers docc-warnings package + +package: + curl -s $(baseUrl)/check-swift-package.sh | bash symlinks: curl -s $(baseUrl)/check-broken-symlinks.sh | bash diff --git a/README.md b/README.md index 41ea43e..efa627c 100644 --- a/README.md +++ b/README.md @@ -2,33 +2,29 @@ Abstract database component, providing a shared API surface for database drivers written in Swift. -[ - ![Release: 1.0.0-beta.3](https://img.shields.io/badge/Release-1%2E0%2E0--beta%2E3-F05138) -]( - https://github.com/feather-framework/feather-database/releases/tag/1.0.0-beta.3 -) +[![Release: 1.0.0-beta.3](https://img.shields.io/badge/Release-1%2E0%2E0--beta%2E3-F05138)](https://github.com/feather-framework/feather-database/releases/tag/1.0.0-beta.3) ## Features -- 🤝 Database-agnostic abstraction layer -- 🔀 Designed for modern Swift concurrency -- 📚 DocC-based API Documentation -- ✅ Unit tests and code coverage +- Database-agnostic abstraction layer +- Designed for modern Swift concurrency +- DocC-based API Documentation +- Unit tests and code coverage ## Requirements ![Swift 6.1+](https://img.shields.io/badge/Swift-6%2E1%2B-F05138) ![Platforms: Linux, macOS, iOS, tvOS, watchOS, visionOS](https://img.shields.io/badge/Platforms-Linux_%7C_macOS_%7C_iOS_%7C_tvOS_%7C_watchOS_%7C_visionOS-F05138) - + - Swift 6.1+ -- Platforms: - - Linux - - macOS 15+ - - iOS 18+ - - tvOS 18+ - - watchOS 11+ - - visionOS 2+ +- Platforms: + - Linux + - macOS 15+ + - iOS 18+ + - tvOS 18+ + - watchOS 11+ + - visionOS 2+ ## Installation @@ -46,19 +42,13 @@ Then add `FeatherDatabase` to your target dependencies: ## Usage -[ - ![DocC API documentation](https://img.shields.io/badge/DocC-API_documentation-F05138) -]( - https://feather-framework.github.io/feather-database/documentation/featherdatabase/ -) - +[![DocC API documentation](https://img.shields.io/badge/DocC-API_documentation-F05138)](https://feather-framework.github.io/feather-database/) API documentation is available at the following link. Refer to the mock objects in the Tests directory if you want to build a custom database driver implementation. > [!WARNING] > This repository is a work in progress, things can break until it reaches v1.0.0. - ## Database drivers The following database driver implementations are available for use: @@ -70,12 +60,12 @@ The following database driver implementations are available for use: ## Development - Build: `swift build` -- Test: - - local: `swift test` - - using Docker: `make docker-test` +- Test: + - local: `swift test` + - using Docker: `make docker-test` - Format: `make format` - Check: `make check` ## Contributing -[Pull requests](https://github.com/feather-framework/feather-database/pulls) are welcome. Please keep changes focused and include tests for new logic. 🙏 +[Pull requests](https://github.com/feather-framework/feather-database/pulls) are welcome. Please keep changes focused and include tests for new logic. From 393250770c4d5c0ca7e2f4e34d9fdb14627030a0 Mon Sep 17 00:00:00 2001 From: GErP83 Date: Wed, 4 Feb 2026 17:18:30 +0100 Subject: [PATCH 3/3] change workflows --- .github/workflows/deployment.yml | 1 + .github/workflows/testing.yml | 4 ++-- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/.github/workflows/deployment.yml b/.github/workflows/deployment.yml index 680623b..672e272 100644 --- a/.github/workflows/deployment.yml +++ b/.github/workflows/deployment.yml @@ -5,6 +5,7 @@ on: tags: - 'v*' - '[0-9]*' + workflow_dispatch: jobs: diff --git a/.github/workflows/testing.yml b/.github/workflows/testing.yml index ebfae0b..68dadfa 100644 --- a/.github/workflows/testing.yml +++ b/.github/workflows/testing.yml @@ -15,7 +15,7 @@ jobs: format_check_enabled : true broken_symlink_check_enabled : true unacceptable_language_check_enabled : true - shell_check_enabled : true + shell_check_enabled : false docs_check_enabled : false api_breakage_check_enabled : false license_header_check_enabled : false @@ -27,7 +27,7 @@ jobs: uses: BinaryBirds/github-workflows/.github/workflows/extra_soundness.yml@main with: local_swift_dependencies_check_enabled : true - headers_check_enabled : true + headers_check_enabled : false docc_warnings_check_enabled : true swiftlang_tests: