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
4 changes: 3 additions & 1 deletion AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
11 changes: 11 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
8 changes: 6 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
5 changes: 5 additions & 0 deletions Package.swift
Original file line number Diff line number Diff line change
Expand Up @@ -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")
],
Expand Down
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"
)
]
```
Expand Down Expand Up @@ -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
Expand Down
4 changes: 3 additions & 1 deletion RELEASING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

Expand Down
2 changes: 1 addition & 1 deletion Sources/MusaveraKit/Documentation.docc/GettingStarted.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"
)
```

Expand Down