Merge branch 'main' of github.com:cmcgee1024/swiftly into streamlined_init

Author: cmcgee1024

.github/workflows/build_release.yml

@@ -23,10 +23,19 @@ jobs:
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4
-      - name: Build Artifact
+      - name: Build Release Artifact
         run: swift run build-swiftly-release ${{ inputs.skip }} ${{ inputs.version }}
-      - name: Upload Artifact
+      - name: Upload Release Artifact
         uses: actions/upload-artifact@v4
         with:
+          name: swiftly-release-x86_64
           path: .build/release/swiftly-*.tar.gz
           if-no-files-found: error
+      - name: Build Documentation Artifacts
+        run: swift package --allow-writing-to-directory .build/docs generate-documentation --target SwiftlyDocs --output-path .build/docs
+      - name: Upload Documentation Artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: swiftly-docs
+          path: .build/docs/**
+          if-no-files-found: error

.github/workflows/pull_request.yml

@@ -43,6 +43,7 @@ jobs:
       - name: Upload Artifact
         uses: actions/upload-artifact@v4
         with:
+          name: swiftly-release-x86_64
           path: .build/release/swiftly-*.tar.gz
           if-no-files-found: error
           retention-days: 1
@@ -55,5 +56,27 @@ jobs:
       linux_os_versions: "[\"jammy\"]"
       linux_exclude_swift_versions: "[{\"swift_version\": \"nightly-main\"},{\"swift_version\": \"nightly-6.0\"},{\"swift_version\": \"5.8\"},{\"swift_version\": \"5.9\"},{\"swift_version\": \"5.10\"}]"
       linux_pre_build_command: ./scripts/prep-gh-action.sh
-      linux_build_command: swift run swiftformat --lint --dryrun .
+      linux_build_command: swift run swiftformat --lint --dryrun . || (echo "Please run 'swift run swiftformat .' to format the source code."; exit 1)
       enable_windows_checks: false
+
+  docscheck:
+    name: Documentation Check
+    runs-on: ubuntu-latest
+    container:
+      image: "swift:6.0-noble"
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+      - name: Prepare the action
+        run: ./scripts/prep-gh-action.sh && ./scripts/install-libarchive.sh
+      - name: Generate Swiftly CLI Reference and Check for Differences
+        run: swift package plugin --allow-writing-to-package-directory generate-docs-reference && git config --global --add safe.directory $(pwd) && git diff --exit-code Documentation/SwiftlyDocs.docc/swiftly-cli-reference.md || (echo "The documentation hasn't been updated with the latest swiftly command-line reference. Please run 'swift package plugin generate-docs-reference' and commit/push the changes."; exit 1)
+      - name: Generate Documentation Set
+        run: swift package --allow-writing-to-directory .build/docs generate-documentation --target SwiftlyDocs --output-path .build/docs
+      - name: Upload Documentation Artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: swiftly-docs
+          path: .build/docs/**
+          if-no-files-found: error
+          retention-days: 1

Documentation/SwiftlyDocs.docc/getting-started.md

@@ -73,6 +73,17 @@ Uninstall this toolchain after you're finished with it:
 $ swiftly uninstall main-snapshot
 ```
 
+# Proxy
+
+Swiftly downloads a list of toolchains from https://www.swift.org/ and retrieves them from Apple/Akamai CDN via https://download.swift.org.
+If your environment requires a proxy, Swiftly will attempt to use the standard environment variables `http_proxy`, `HTTP_PROXY`, `https_proxy` or `HTTPS_PROXY` to determine which proxy server to use instead of making a direct connection.
+
+To download latest nightly snapshot using a proxy:
+```
+$ export https_proxy=http://proxy:3128
+$ swiftly install main-snapshot
+```
+
 # See Also:
 
 - [Install Toolchains](install-toolchains)

Sources/SwiftlyCore/HTTPClient.swift

@@ -10,9 +10,48 @@ public protocol HTTPRequestExecutor {
 }
 
 /// An `HTTPRequestExecutor` backed by the shared `HTTPClient`.
-internal struct HTTPRequestExecutorImpl: HTTPRequestExecutor {
+internal class HTTPRequestExecutorImpl: HTTPRequestExecutor {
+    let httpClient: HTTPClient
+
+    public init() {
+        var proxy: HTTPClient.Configuration.Proxy?
+
+        func getProxyFromEnv(keys: [String]) -> HTTPClient.Configuration.Proxy? {
+            let environment = ProcessInfo.processInfo.environment
+            for key in keys {
+                if let proxyString = environment[key],
+                   let url = URL(string: proxyString),
+                   let host = url.host,
+                   let port = url.port
+                {
+                    return .server(host: host, port: port)
+                }
+            }
+            return nil
+        }
+
+        if let httpProxy = getProxyFromEnv(keys: ["http_proxy", "HTTP_PROXY"]) {
+            proxy = httpProxy
+        }
+        if let httpsProxy = getProxyFromEnv(keys: ["https_proxy", "HTTPS_PROXY"]) {
+            proxy = httpsProxy
+        }
+
+        if proxy != nil {
+            self.httpClient = HTTPClient(eventLoopGroupProvider: .singleton, configuration: HTTPClient.Configuration(proxy: proxy))
+        } else {
+            self.httpClient = HTTPClient.shared
+        }
+    }
+
+    deinit {
+        if httpClient !== HTTPClient.shared {
+            try? httpClient.syncShutdown()
+        }
+    }
+
     public func execute(_ request: HTTPClientRequest, timeout: TimeAmount) async throws -> HTTPClientResponse {
-        try await HTTPClient.shared.execute(request, timeout: timeout)
+        try await self.httpClient.execute(request, timeout: timeout)
     }
 }
 

Tests/SwiftlyTests/SwiftlyTests.swift

@@ -17,51 +17,7 @@ struct SwiftlyTestError: LocalizedError {
     let message: String
 }
 
-var proxyExecutorInstalled = false
-
-/// An `HTTPRequestExecutor` backed by an `HTTPClient` that can take http proxy
-/// information from the environment in either HTTP_PROXY or HTTPS_PROXY
-class ProxyHTTPRequestExecutorImpl: HTTPRequestExecutor {
-    let httpClient: HTTPClient
-    public init() {
-        var proxy: HTTPClient.Configuration.Proxy?
-
-        let environment = ProcessInfo.processInfo.environment
-        let httpProxy = environment["HTTP_PROXY"]
-        if let httpProxy, let url = URL(string: httpProxy), let host = url.host, let port = url.port {
-            proxy = .server(host: host, port: port)
-        }
-
-        let httpsProxy = environment["HTTPS_PROXY"]
-        if let httpsProxy, let url = URL(string: httpsProxy), let host = url.host, let port = url.port {
-            proxy = .server(host: host, port: port)
-        }
-
-        if proxy != nil {
-            self.httpClient = HTTPClient(eventLoopGroupProvider: .singleton, configuration: HTTPClient.Configuration(proxy: proxy))
-        } else {
-            self.httpClient = HTTPClient.shared
-        }
-    }
-
-    public func execute(_ request: HTTPClientRequest, timeout: TimeAmount) async throws -> HTTPClientResponse {
-        try await self.httpClient.execute(request, timeout: timeout)
-    }
-
-    deinit {
-        if httpClient !== HTTPClient.shared {
-            try? httpClient.syncShutdown()
-        }
-    }
-}
-
 class SwiftlyTests: XCTestCase {
-    override class func setUp() {
-        if !proxyExecutorInstalled {
-            SwiftlyCore.httpRequestExecutor = ProxyHTTPRequestExecutorImpl()
-        }
-    }
-
     override class func tearDown() {
 #if os(Linux)
         let deleteTestGPGKeys = Process()