Skip to content

Commit e876472

Browse files
Update installation instructions (#151)
* wip * wip * Clarify how to depend on this library. * Update README.md * Update Sources/IssueReporting/Documentation.docc/IssueReporting.md * wip * disable windows --------- Co-authored-by: Stephen Celis <[email protected]>
1 parent 39de59b commit e876472

File tree

4 files changed

+68
-25
lines changed

4 files changed

+68
-25
lines changed

.github/workflows/ci.yml

+22-22
Original file line numberDiff line numberDiff line change
@@ -112,28 +112,28 @@ jobs:
112112
- name: Build
113113
run: swift build --target IssueReporting --swift-sdk wasm32-unknown-wasi -Xlinker -z -Xlinker stack-size=$((1024 * 1024))
114114

115-
windows:
116-
name: Windows
117-
strategy:
118-
matrix:
119-
os: [windows-latest]
120-
config:
121-
- debug
122-
- release
123-
fail-fast: false
124-
runs-on: ${{ matrix.os }}
125-
steps:
126-
- uses: compnerd/gha-setup-swift@main
127-
with:
128-
branch: swift-6.0.3-release
129-
tag: 6.0.3-RELEASE
130-
- name: Set long paths
131-
run: git config --system core.longpaths true
132-
- uses: actions/checkout@v4
133-
- name: Build
134-
run: swift build -c ${{ matrix.config }}
135-
- name: Run tests (debug only)
136-
run: swift test
115+
# windows:
116+
# name: Windows
117+
# strategy:
118+
# matrix:
119+
# os: [windows-latest]
120+
# config:
121+
# - debug
122+
# - release
123+
# fail-fast: false
124+
# runs-on: ${{ matrix.os }}
125+
# steps:
126+
# - uses: compnerd/gha-setup-swift@main
127+
# with:
128+
# branch: swift-6.0.3-release
129+
# tag: 6.0.3-RELEASE
130+
# - name: Set long paths
131+
# run: git config --system core.longpaths true
132+
# - uses: actions/checkout@v4
133+
# - name: Build
134+
# run: swift build -c ${{ matrix.config }}
135+
# - name: Run tests (debug only)
136+
# run: swift test
137137

138138
android:
139139
name: Android

README.md

+11-3
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,14 @@ assertions, and do so in a testable manner.
99

1010
## Overview
1111

12+
> [!Important]
13+
> Issue Reporting is an evolution of our previous library, XCTestDynamicOverlay. As such,
14+
> to use this library you must depend on the old repository URL:
15+
>
16+
> ```
17+
> https://github.com/pointfreeco/xctest-dynamic-overlay
18+
> ```
19+
1220
This library provides robust tools for reporting issues in your application with a customizable
1321
degree of granularity and severity. In its most basic form you use the `reportIssue` function
1422
anywhere in your application to flag an issue in your code, such as a code path that you think
@@ -72,9 +80,9 @@ There are many popular libraries out there using Issue Reporting. To name a few:
7280
to explicitly declare its dependencies, and when a new dependency is introduced to a feature,
7381
existing tests will fail until they account for it.
7482

75-
<!-- * [**Swift Navigation**](https://github.com/pointfreeco/swiftui-navigation) provides concise-->
76-
<!-- domain modeling tools for UI frameworks including SwiftUI, UIKit, and more; and it uses Swift-->
77-
<!-- Issue Reporting to raise runtime warnings when APIs are used in unexpected ways.-->
83+
* [**Swift Navigation**](https://github.com/pointfreeco/swift-navigation) provides concise
84+
domain modeling tools for UI frameworks including SwiftUI, UIKit, and more; and it uses Swift
85+
Issue Reporting to raise runtime warnings when APIs are used in unexpected ways.
7886

7987
* [**The Composable Architecture**](https://github.com/pointfreeco/swift-composable-architecture)
8088
comes with powerful testing tools that support both Swift Testing and XCTest out of the box

Sources/IssueReporting/Documentation.docc/Articles/GettingStarted.md

+27
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,33 @@
22

33
Learn how to report issues in your application code, and how to customize how issues are reported.
44

5+
## Installation
6+
7+
Issue Reporting is an evolution of our previous library, XCTestDynamicOverlay. As such, to use this
8+
library you must depend on the old repository URL. This means if you are using the Xcode
9+
"Package Dependencies" interface you will enter the following URL when adding the package:
10+
11+
```
12+
https://github.com/pointfreeco/xctest-dynamic-overlay
13+
```
14+
15+
And if you are using an SPM Package.swift file you will specify the dependency like so:
16+
17+
```swift
18+
.package(url: "https://github.com/pointfreeco/xctest-dynamic-overlay", from: "1.5.0"),
19+
```
20+
21+
…and add the dependency product to your target like so:
22+
23+
```swift
24+
.target(
25+
"MyTarget",
26+
dependencies: [
27+
.product(name: "IssueReporting", package: "xctest-dynamic-overlay")
28+
]
29+
)
30+
```
31+
532
## Reporting issues
633

734
The primary tool for reporting an issue in your application code is the

Sources/IssueReporting/Documentation.docc/IssueReporting.md

+8
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,14 @@ assertions, and do so in a testable manner.
55

66
## Overview
77

8+
> Important:
9+
> Issue Reporting is an evolution of our previous library, XCTestDynamicOverlay. As such,
10+
> to use this library you must depend on the old repository URL:
11+
>
12+
> ```
13+
> https://github.com/pointfreeco/xctest-dynamic-overlay
14+
> ```
15+
816
This library provides robust tools for reporting issues in your application with a customizable
917
degree of granularity and severity. In its most basic form you use the unified
1018
[`reportIssue`](<doc:reportIssue(_:fileID:filePath:line:column:)>) function anywhere in your

0 commit comments

Comments
 (0)