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: diff --git a/Makefile b/Makefile index 8c5a82c..072a467 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 package docc-warnings + +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 f8c2340..c9bef3f 100644 --- a/README.md +++ b/README.md @@ -2,33 +2,28 @@ The FeatherOpenAPI library makes it easy to define OpenAPI specifications using Swift in a type-safe way. -[ - ![Release: 1.0.0-beta.1](https://img.shields.io/badge/Release-1%2E0%2E0--beta%2E1-F05138) -]( - https://github.com/feather-framework/feather-openapi/releases/tag/1.0.0-beta.1 -) +[![Release: 1.0.0-beta.1](https://img.shields.io/badge/Release-1%2E0%2E0--beta%2E1-F05138)](https://github.com/feather-framework/feather-openapi/releases/tag/1.0.0-beta.1) ## Features -- 🤝 Type-safe interface for building OpenAPI documents -- 🔀 Automatic identifier generation and resolution -- 📚 DocC-based API Documentation -- ✅ Unit tests and code coverage +- Type-safe interface for building OpenAPI documents +- Automatic identifier generation and resolution +- 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+ +- Swift 6.1+ +- Platforms: + - Linux + - macOS 15+ + - iOS 18+ + - tvOS 18+ + - watchOS 11+ + - visionOS 2+ ## Installation @@ -45,48 +40,23 @@ Then add `FeatherOpenAPI` to your target dependencies: ``` ## Usage - -[ - ![DocC API documentation](https://img.shields.io/badge/DocC-API_documentation-F05138) -] ( - https://feather-framework.github.io/feather-openapi/documentation/featheropenapi/ -) -API documentation is available at the following link. +[![DocC API documentation](https://img.shields.io/badge/DocC-API_documentation-F05138)] (https://feather-framework.github.io/feather-openapi/) + +API documentation is available at the following link. > [!WARNING] > This repository is a work in progress, things can break until it reaches v1.0.0. - ## 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-openapi/pulls) are welcome. Please keep changes focused and include tests for new logic. 🙏 - - - - - - - - - - - - - - - - - - - - +[Pull requests](https://github.com/feather-framework/feather-openapi/pulls) are welcome. Please keep changes focused and include tests for new logic.