From 188037072f38dc1d1858b74d6d9bd9a425f2a636 Mon Sep 17 00:00:00 2001 From: rudrankriyam Date: Fri, 10 Jul 2026 20:23:48 +0530 Subject: [PATCH 1/2] Fix DocC catalog handling --- AGENTS.md | 4 +++- CONTRIBUTING.md | 8 ++++++-- Package.swift | 5 +++++ RELEASING.md | 4 +++- 4 files changed, 17 insertions(+), 4 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index 92075fd..47b7bbe 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -66,7 +66,9 @@ xcodebuild \ Generate DocC documentation after changing public APIs: ```bash -swift package generate-documentation --target MusaveraKit +swift package generate-documentation \ + --target MusaveraKit \ + Sources/MusaveraKit/Documentation.docc ``` ## Pull Requests diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d43db4c..cfda2ac 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -74,13 +74,17 @@ requirements, or recommended usage changes. Generate the documentation locally with: ```bash -swift package generate-documentation --target MusaveraKit +swift package generate-documentation \ + --target MusaveraKit \ + Sources/MusaveraKit/Documentation.docc ``` Preview it with: ```bash -swift package --disable-sandbox preview-documentation --target MusaveraKit +swift package --disable-sandbox preview-documentation \ + --target MusaveraKit \ + Sources/MusaveraKit/Documentation.docc ``` ## Code Style diff --git a/Package.swift b/Package.swift index 602a390..28465e3 100644 --- a/Package.swift +++ b/Package.swift @@ -23,6 +23,11 @@ let package = Package( targets: [ .target( name: "MusaveraKit", + // SwiftPM otherwise reports the DocC catalog as an unhandled file. + // Documentation commands pass the catalog path explicitly. + exclude: [ + "Documentation.docc" + ], resources: [ .copy("PrivacyInfo.xcprivacy") ], diff --git a/RELEASING.md b/RELEASING.md index 60c849c..688eb08 100644 --- a/RELEASING.md +++ b/RELEASING.md @@ -25,7 +25,9 @@ xcodebuild \ -destination 'generic/platform=iOS' \ -derivedDataPath .build/xcode \ build -swift package generate-documentation --target MusaveraKit +swift package generate-documentation \ + --target MusaveraKit \ + Sources/MusaveraKit/Documentation.docc git diff --check ``` From 952beb98079499e0ec9083799142d622152b986c Mon Sep 17 00:00:00 2001 From: rudrankriyam Date: Fri, 10 Jul 2026 20:23:54 +0530 Subject: [PATCH 2/2] Release 0.2.1 --- CHANGELOG.md | 11 +++++++++++ README.md | 6 ++++-- .../MusaveraKit/Documentation.docc/GettingStarted.md | 2 +- 3 files changed, 16 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index b9b7674..8a112a3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,17 @@ and releases follow [Semantic Versioning](https://semver.org/spec/v2.0.0.html). ## Unreleased +## 0.2.1 - 2026-07-10 + +### Changed + +- Updated the repository checkout action to version 7. + +### Fixed + +- Stopped SwiftPM from reporting the DocC catalog as an unhandled target file + while preserving the complete generated documentation archive. + ## 0.2.0 - 2026-06-13 ### Added diff --git a/README.md b/README.md index 2f62a9f..66227b4 100644 --- a/README.md +++ b/README.md @@ -54,7 +54,7 @@ Add MusaveraKit with Swift Package Manager: dependencies: [ .package( url: "https://github.com/rryam/MusaveraKit.git", - from: "0.2.0" + from: "0.2.1" ) ] ``` @@ -215,7 +215,9 @@ Scripts/validate-repository.sh Generate DocC documentation: ```bash -swift package generate-documentation --target MusaveraKit +swift package generate-documentation \ + --target MusaveraKit \ + Sources/MusaveraKit/Documentation.docc ``` ## Documentation and Resources diff --git a/Sources/MusaveraKit/Documentation.docc/GettingStarted.md b/Sources/MusaveraKit/Documentation.docc/GettingStarted.md index 883b6b3..d5d2e7a 100644 --- a/Sources/MusaveraKit/Documentation.docc/GettingStarted.md +++ b/Sources/MusaveraKit/Documentation.docc/GettingStarted.md @@ -9,7 +9,7 @@ Add MusaveraKit to your package dependencies: ```swift .package( url: "https://github.com/rryam/MusaveraKit.git", - from: "0.2.0" + from: "0.2.1" ) ```