From 7cbe6e845b892d33c292deec657ef698c5348640 Mon Sep 17 00:00:00 2001 From: Brandon Williams Date: Thu, 27 Feb 2025 09:04:57 -0800 Subject: [PATCH 1/7] wip --- README.md | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 40798bf..29ffa65 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,13 @@ assertions, and do so in a testable manner. ## Overview +> Important: Issue Reporting is an evolution of our previous library, XCTestDynamicOverlay. As such, +> to use this library you must depend on the old repository URL, which is +> +> ``` +> https://github.com/pointfreeco/xctest-dynamic-overlay +> ``` + This library provides robust tools for reporting issues in your application with a customizable degree of granularity and severity. In its most basic form you use the `reportIssue` function anywhere in your application to flag an issue in your code, such as a code path that you think @@ -72,9 +79,9 @@ There are many popular libraries out there using Issue Reporting. To name a few: to explicitly declare its dependencies, and when a new dependency is introduced to a feature, existing tests will fail until they account for it. - - - + * [**Swift Navigation**](https://github.com/pointfreeco/swift-navigation) provides concise + domain modeling tools for UI frameworks including SwiftUI, UIKit, and more; and it uses Swift + Issue Reporting to raise runtime warnings when APIs are used in unexpected ways. * [**The Composable Architecture**](https://github.com/pointfreeco/swift-composable-architecture) comes with powerful testing tools that support both Swift Testing and XCTest out of the box From e043e96a97627fd6f6d012742ddcd39019d11923 Mon Sep 17 00:00:00 2001 From: Brandon Williams Date: Thu, 27 Feb 2025 09:05:45 -0800 Subject: [PATCH 2/7] wip --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 29ffa65..a2732d1 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,8 @@ assertions, and do so in a testable manner. ## Overview -> Important: Issue Reporting is an evolution of our previous library, XCTestDynamicOverlay. As such, +> [!Important] +> Issue Reporting is an evolution of our previous library, XCTestDynamicOverlay. As such, > to use this library you must depend on the old repository URL, which is > > ``` From dd9e9ae9091260142523151d435a7deb4be1db41 Mon Sep 17 00:00:00 2001 From: Brandon Williams Date: Thu, 27 Feb 2025 09:09:48 -0800 Subject: [PATCH 3/7] Clarify how to depend on this library. --- .../Articles/GettingStarted.md | 16 ++++++++++++++++ .../Documentation.docc/IssueReporting.md | 8 ++++++++ 2 files changed, 24 insertions(+) diff --git a/Sources/IssueReporting/Documentation.docc/Articles/GettingStarted.md b/Sources/IssueReporting/Documentation.docc/Articles/GettingStarted.md index 6084194..8c72efa 100644 --- a/Sources/IssueReporting/Documentation.docc/Articles/GettingStarted.md +++ b/Sources/IssueReporting/Documentation.docc/Articles/GettingStarted.md @@ -2,6 +2,22 @@ Learn how to report issues in your application code, and how to customize how issues are reported. +## Installation + +Issue Reporting is an evolution of our previous library, XCTestDynamicOverlay. As such, to use this +library you must depend on the old repository URL. This means if you are using the Xcode +"Package Dependencies" interface you will enter the following URL when adding the package: + +``` +https://github.com/pointfreeco/xctest-dynamic-overlay +``` + +And if you are using an SPM Package.swift file you will specify the dependency like so: + +```swift +.package(url: "https://github.com/pointfreeco/xctest-dynamic-overlay", from: "1.5.0"), +``` + ## Reporting issues The primary tool for reporting an issue in your application code is the diff --git a/Sources/IssueReporting/Documentation.docc/IssueReporting.md b/Sources/IssueReporting/Documentation.docc/IssueReporting.md index dc51e5a..f57b3e1 100644 --- a/Sources/IssueReporting/Documentation.docc/IssueReporting.md +++ b/Sources/IssueReporting/Documentation.docc/IssueReporting.md @@ -5,6 +5,14 @@ assertions, and do so in a testable manner. ## Overview +> Important: +> Issue Reporting is an evolution of our previous library, XCTestDynamicOverlay. As such, +> to use this library you must depend on the old repository URL, which is +> +> ``` +> https://github.com/pointfreeco/xctest-dynamic-overlay +> ``` + This library provides robust tools for reporting issues in your application with a customizable degree of granularity and severity. In its most basic form you use the unified [`reportIssue`]() function anywhere in your From 69389107e4732e11a948a80c023089673859f798 Mon Sep 17 00:00:00 2001 From: Stephen Celis Date: Thu, 27 Feb 2025 09:31:27 -0800 Subject: [PATCH 4/7] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a2732d1..534d5da 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ assertions, and do so in a testable manner. > [!Important] > Issue Reporting is an evolution of our previous library, XCTestDynamicOverlay. As such, -> to use this library you must depend on the old repository URL, which is +> to use this library you must depend on the old repository URL: > > ``` > https://github.com/pointfreeco/xctest-dynamic-overlay From f6528d5e1c7d4d0d66eb03e54c37839ee3d55ca3 Mon Sep 17 00:00:00 2001 From: Stephen Celis Date: Thu, 27 Feb 2025 09:32:02 -0800 Subject: [PATCH 5/7] Update Sources/IssueReporting/Documentation.docc/IssueReporting.md --- Sources/IssueReporting/Documentation.docc/IssueReporting.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Sources/IssueReporting/Documentation.docc/IssueReporting.md b/Sources/IssueReporting/Documentation.docc/IssueReporting.md index f57b3e1..c1b002d 100644 --- a/Sources/IssueReporting/Documentation.docc/IssueReporting.md +++ b/Sources/IssueReporting/Documentation.docc/IssueReporting.md @@ -7,7 +7,7 @@ assertions, and do so in a testable manner. > Important: > Issue Reporting is an evolution of our previous library, XCTestDynamicOverlay. As such, -> to use this library you must depend on the old repository URL, which is +> to use this library you must depend on the old repository URL: > > ``` > https://github.com/pointfreeco/xctest-dynamic-overlay From a7525f427359715f35cd8a759b5a5848b5edbc0c Mon Sep 17 00:00:00 2001 From: Brandon Williams Date: Thu, 27 Feb 2025 10:00:12 -0800 Subject: [PATCH 6/7] wip --- .../Documentation.docc/Articles/GettingStarted.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/Sources/IssueReporting/Documentation.docc/Articles/GettingStarted.md b/Sources/IssueReporting/Documentation.docc/Articles/GettingStarted.md index 8c72efa..2ac0c3a 100644 --- a/Sources/IssueReporting/Documentation.docc/Articles/GettingStarted.md +++ b/Sources/IssueReporting/Documentation.docc/Articles/GettingStarted.md @@ -18,6 +18,17 @@ And if you are using an SPM Package.swift file you will specify the dependency l .package(url: "https://github.com/pointfreeco/xctest-dynamic-overlay", from: "1.5.0"), ``` +…and add the dependency product to your target like so: + +```swift +.target( + "MyTarget", + dependencies: [ + .product(name: "IssueReporting", package: "xctest-dynamic-overlay") + ] +) +``` + ## Reporting issues The primary tool for reporting an issue in your application code is the From 757772ff15193896ffb53a5278da4b77a63094e8 Mon Sep 17 00:00:00 2001 From: Brandon Williams Date: Thu, 27 Feb 2025 11:39:31 -0800 Subject: [PATCH 7/7] disable windows --- .github/workflows/ci.yml | 44 ++++++++++++++++++++-------------------- 1 file changed, 22 insertions(+), 22 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index d32bd45..b2033d8 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -112,28 +112,28 @@ jobs: - name: Build run: swift build --target IssueReporting --swift-sdk wasm32-unknown-wasi -Xlinker -z -Xlinker stack-size=$((1024 * 1024)) - windows: - name: Windows - strategy: - matrix: - os: [windows-latest] - config: - - debug - - release - fail-fast: false - runs-on: ${{ matrix.os }} - steps: - - uses: compnerd/gha-setup-swift@main - with: - branch: swift-6.0.3-release - tag: 6.0.3-RELEASE - - name: Set long paths - run: git config --system core.longpaths true - - uses: actions/checkout@v4 - - name: Build - run: swift build -c ${{ matrix.config }} - - name: Run tests (debug only) - run: swift test + # windows: + # name: Windows + # strategy: + # matrix: + # os: [windows-latest] + # config: + # - debug + # - release + # fail-fast: false + # runs-on: ${{ matrix.os }} + # steps: + # - uses: compnerd/gha-setup-swift@main + # with: + # branch: swift-6.0.3-release + # tag: 6.0.3-RELEASE + # - name: Set long paths + # run: git config --system core.longpaths true + # - uses: actions/checkout@v4 + # - name: Build + # run: swift build -c ${{ matrix.config }} + # - name: Run tests (debug only) + # run: swift test android: name: Android