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

Author: cmcgee1024

.github/workflows/build_release.yml

@@ -0,0 +1,32 @@
+name: Build Release
+
+on:
+  workflow_dispatch:
+    inputs:
+      version:
+        description: "Version of swiftly to build release artifacts"
+        required: true
+        type: string
+        default: "0.3.0"
+      skip:
+        description: "Perform release checks, such as the git tag, and swift version, or '--skip' to skip that."
+        required: true
+        type: string
+        default: "--skip"
+
+jobs:
+  buildrelease:
+    name: Build Release
+    runs-on: ubuntu-latest
+    container:
+      image: "swift:6.0-rhel-ubi9"
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+      - name: Build Artifact
+        run: swift run build-swiftly-release ${{ inputs.skip }} ${{ inputs.version }}
+      - name: Upload Artifact
+        uses: actions/upload-artifact@v4
+        with:
+          path: .build/release/swiftly-*.tar.gz
+          if-no-files-found: error

.github/workflows/pull_request.yml

@@ -0,0 +1,59 @@
+name: Pull Request
+
+on:
+  pull_request:
+    types: [opened, reopened, synchronize]
+  push:
+    branches: [main]
+
+jobs:
+  soundness:
+    name: Soundness
+    uses: swiftlang/github-workflows/.github/workflows/soundness.yml@main
+    with:
+      license_header_check_enabled: false
+      license_header_check_project_name: "Swift.org"
+      api_breakage_check_enabled: false
+      docs_check_enabled: false
+      format_check_enabled: false
+      shell_check_enabled: false
+      unacceptable_language_check_enabled: true
+
+  tests:
+    name: Test
+    uses: swiftlang/github-workflows/.github/workflows/swift_package_test.yml@main
+    with:
+      # Amazon Linux 2 won't work with GH infrastructure
+      linux_os_versions: "[\"jammy\", \"focal\", \"rhel-ubi9\", \"noble\", \"bookworm\", \"fedora39\"]"
+      # We only care about the current stable release, because that's where we make our swiftly releases
+      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 && ./scripts/install-libarchive.sh
+      enable_windows_checks: false
+
+  releasebuildcheck:
+    name: Release Build Check
+    runs-on: ubuntu-latest
+    container:
+      image: "swift:6.0-rhel-ubi9"
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+      - name: Build Artifact
+        run: swift run build-swiftly-release --skip "999.0.0"
+      - name: Upload Artifact
+        uses: actions/upload-artifact@v4
+        with:
+          path: .build/release/swiftly-*.tar.gz
+          if-no-files-found: error
+          retention-days: 1
+
+  formatcheck:
+    name: Format Check
+    uses: swiftlang/github-workflows/.github/workflows/swift_package_test.yml@main
+    with:
+      # We only need to run this with one swift release and on one of the linux distributions
+      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 .
+      enable_windows_checks: false

DESIGN.md

@@ -67,7 +67,7 @@ A simple setup for managing the toolchains could look like this:
 
 The toolchains (i.e. the contents of a given Swift download tarball) would be contained in the toolchains directory, each named according to the major/minor/patch version. `config.json` would contain any required metadata (e.g. the latest Swift version, which toolchain is selected, etc.). If pulling in Foundation to use `JSONEncoder`/`JSONDecoder` (or some other JSON tool) would be a problem, we could also use something simpler.
 
-The `~/.local/bin` directory would include symlinks pointing to swiftly itself. When the proxies binaries are executed swiftly proxies them to the requested toolchain, or the default.
+The `~/.local/share/swiftly/bin` directory would include symlinks pointing to swiftly itself. When the proxies binaries are executed swiftly proxies them to the requested toolchain, or the default.
 
 This is all very similar to how rustup does things, but I figure there's no need to reinvent the wheel here.
 
@@ -115,7 +115,7 @@ This will install the latest available stable release of Swift. If the latest ve
 
 ##### Installing a specific release version of Swift
 
-To install a specific version of Swift, the user can provide it. 
+To install a specific version of Swift, the user can provide it.
 
 If a patch version isn't specified, it’ll install the latest patch version that matches the minor version provided. If a version is already installed that has the same major and minor version, a message will be printed indicating so and directing the user to `swiftly update a.b` if they wish to check for updates. 
 
@@ -306,19 +306,21 @@ This command will provide the full path to the directory where the selected tool
 
 #### Run with a selected toolchain
 
-There are cases where you might want to run an arbitrary command using a selected toolchain. An example could be that you want to build something with CMake.
+There are cases where you might want to run an arbitrary command using a selected toolchain. An example could be that you want to build something with CMake or Autoconf.
 
 ```
 # CMake
-swiftly run cmake -G ninja
+swiftly run cmake -G ninja -D CMAKE_C_COMPILER=clang -D CMAKE_CXX_COMPILER=clang++
 swiftly run ninja build
 
 # Autoconf
-swiftly run ./configure
-swiftly run make
+CC=clang swiftly run ./configure
+CC=clang swiftly run make
 ```
 
-Swiftly adjusts certain environment variables, such as prefixing the PATH to the selected toolchain directory, and setting the CC and CXX variables to the locations of clang and clang++ in those toolchains so that the build tools use them. If you want to explicitly specify a toolchain for the command you can do that with a selector notation like this:
+Swiftly prefixes the PATH to the selected toolchain directory and runs the command so that the toolchain executables are available and have precedence.
+
+If you want to explicitly specify a toolchain for the command you can do that with a selector notation like this:
 
 ```
 swiftly run swift build +5.10.1 # Runs swift build with the 5.10.1 toolchain
@@ -333,8 +335,8 @@ If the selected toolchain is not installed then swiftly will exit with a message
 swiftly run swift build +main-snapshot
 
 # Generate makefiles with the latest released Swift toolchain
-swiftly run +latest cmake -G "Unix Makefile"
-swiftly run +latest make
+swiftly run +latest cmake -G "Unix Makefile" -D CMAKE_C_COMPILER=clang
+CC=clang swiftly run +latest make
 ```
 
 ## Detailed Design
@@ -498,7 +500,7 @@ If the tag is a newer version than the installed one, a prompt indicating the ne
 $ dpkg --status libcurl4
 ```
 
-If the exit code of the previous command was 0, then we know the dependency exists and can return true. If it wasn't, then we call fall back to attempting to locate the library via `pkg-config`:
+If the exit code of the previous command was 0, then we know the dependency exists and can return true. If it wasn't, then we can fall back to attempting to locate the library via `pkg-config`:
 
 ```
 $ pkg-config --exists libcurl

Documentation/SwiftlyDocs.docc/getting-started.md

@@ -43,7 +43,7 @@ $ swift --version
 Swift version 6.0.1 (swift-6.0.1-RELEASE)
 Target: x86_64-unknown-linux-gnu
 
-$ swift build    # Build your package with the latest toolchain
+$ swift build    # Build with the latest (5.8.1) toolchain
 ```
 
 You can install (and use) another release toolchain:

Documentation/SwiftlyDocs.docc/swiftly-cli-reference.md

@@ -501,7 +501,7 @@ You can run one of the usual toolchain commands directly:
 
 Or you can run another program (or script) that runs one or more toolchain commands:
 
-    $ swiftly run make  # Builds targets using clang/swiftc
+    $ CC=clang swiftly run make  # Builds targets using clang
     $ swiftly run ./build-things.sh  # Script invokes 'swift build' to create certain product binaries
 
 Toolchain selection is determined by swift version files `.swift-version`, with a default global as the fallback. See the `swiftly use` command for more details.

NOTICE.txt

@@ -56,6 +56,6 @@ following third party libraries:
 * libarchive - Copyright (c) 2003-2018 Tim Kientzle. All rights reserved.
 
   * LICENSE ("New BSD license"):
-    * https://raw.githubusercontent.com/libarchive/libarchive/master/COPYING
+    * https://raw.githubusercontent.com/libarchive/libarchive/release/COPYING
   * HOMEPAGE:
     * http://www.libarchive.org/

Package.resolved

@@ -17,7 +17,7 @@ let package = Package(
         .package(url: "https://github.com/apple/swift-argument-parser", from: "1.3.0"),
         .package(url: "https://github.com/swift-server/async-http-client", from: "1.21.2"),
         .package(url: "https://github.com/apple/swift-nio.git", from: "2.64.0"),
-        .package(url: "https://github.com/apple/swift-tools-support-core.git", from: "0.6.1"),
+        .package(url: "https://github.com/apple/swift-tools-support-core.git", from: "0.7.1"),
         .package(url: "https://github.com/apple/swift-docc-plugin", from: "1.3.0"),
         // This dependency provides the correct version of the formatter so that you can run `swift run swiftformat Package.swift Plugins/ Sources/ Tests/`
         .package(url: "https://github.com/nicklockwood/SwiftFormat", exact: "0.49.18"),

Package.swift

@@ -9,7 +9,6 @@ var swiftGPGKeysRefreshed = false
 public struct Linux: Platform {
     let linuxPlatforms = [
         PlatformDefinition.ubuntu2404,
-        PlatformDefinition.ubuntu2310,
         PlatformDefinition.ubuntu2204,
         PlatformDefinition.ubuntu2004,
         PlatformDefinition.ubuntu1804,
@@ -26,17 +25,15 @@ public struct Linux: Platform {
             return URL(fileURLWithPath: dir)
         } else {
             return FileManager.default.homeDirectoryForCurrentUser
-                .appendingPathComponent(".local", isDirectory: true)
-                .appendingPathComponent("share", isDirectory: true)
+                .appendingPathComponent(".local/share", isDirectory: true)
         }
     }
 
     public var swiftlyBinDir: URL {
         SwiftlyCore.mockedHomeDir.map { $0.appendingPathComponent("bin", isDirectory: true) }
             ?? ProcessInfo.processInfo.environment["SWIFTLY_BIN_DIR"].map { URL(fileURLWithPath: $0) }
             ?? FileManager.default.homeDirectoryForCurrentUser
-            .appendingPathComponent(".local", isDirectory: true)
-            .appendingPathComponent("bin", isDirectory: true)
+            .appendingPathComponent(".local/share/swiftly/bin", isDirectory: true)
     }
 
     public var swiftlyToolchainsDir: URL {
@@ -137,27 +134,6 @@ public struct Linux: Platform {
                 "tzdata",
                 "zlib1g-dev",
             ]
-        case "ubuntu2310":
-            [
-                "binutils",
-                "git",
-                "unzip",
-                "gnupg2",
-                "libc6-dev",
-                "libcurl4-openssl-dev",
-                "libedit2",
-                "libgcc-12-dev",
-                "libpython3-dev",
-                "libsqlite3-0",
-                "libstdc++-12-dev",
-                "libxml2-dev",
-                "libncurses-dev",
-                "libz3-dev",
-                "pkg-config",
-                "python3-lldb-13",
-                "tzdata",
-                "zlib1g-dev",
-            ]
         case "ubuntu2404":
             [
                 "binutils",
@@ -224,6 +200,8 @@ public struct Linux: Platform {
                 "libuuid-devel",
                 "libxml2-devel",
                 "python3-devel",
+                "libstdc++-devel",
+                "libstdc++-static",
             ]
         case "debian12":
             [
@@ -240,6 +218,7 @@ public struct Linux: Platform {
                 "tzdata",
                 "git",
                 "gcc",
+                "libstdc++-12-dev",
             ]
         default:
             []
@@ -252,8 +231,6 @@ public struct Linux: Platform {
             "apt-get"
         case "ubuntu2204":
             "apt-get"
-        case "ubuntu2310":
-            "apt-get"
         case "ubuntu2404":
             "apt-get"
         case "amazonlinux2":
@@ -552,7 +529,7 @@ public struct Linux: Platform {
             }
 
             return PlatformDefinition.rhel9
-        } else if let pd = [PlatformDefinition.ubuntu1804, .ubuntu2004, .ubuntu2204, .ubuntu2310, .ubuntu2404, .debian12, .fedora39].first(where: { $0.name == id + versionID }) {
+        } else if let pd = [PlatformDefinition.ubuntu1804, .ubuntu2004, .ubuntu2204, .ubuntu2404, .debian12, .fedora39].first(where: { $0.name == id + versionID }) {
             return pd
         }
 

Sources/LinuxPlatform/Linux.swift

@@ -71,7 +71,7 @@ internal struct Init: SwiftlyCommand {
         // Ensure swiftly doesn't overwrite any existing executables without getting confirmation first.
         let swiftlyBinDir = Swiftly.currentPlatform.swiftlyBinDir
         let swiftlyBinDirContents = (try? FileManager.default.contentsOfDirectory(atPath: swiftlyBinDir.path)) ?? [String]()
-        let willBeOverwritten = Set(proxyList + ["swiftly"]).intersection(swiftlyBinDirContents)
+        let willBeOverwritten = Set(["swiftly"]).intersection(swiftlyBinDirContents)
         if !willBeOverwritten.isEmpty && !overwrite {
             SwiftlyCore.print("The following existing executables will be overwritten:")
 
@@ -159,30 +159,6 @@ internal struct Init: SwiftlyCommand {
             }
         }
 
-        // Don't create the proxies in the tests
-        if !cmd.path.hasSuffix("xctest") {
-            SwiftlyCore.print("Setting up toolchain proxies...")
-
-            let proxyTo = if let systemManagedSwiftlyBin = systemManagedSwiftlyBin {
-                systemManagedSwiftlyBin
-            } else {
-                swiftlyBin.path
-            }
-
-            for p in proxyList {
-                let proxy = Swiftly.currentPlatform.swiftlyBinDir.appendingPathComponent(p)
-
-                if proxy.fileExists() {
-                    try FileManager.default.removeItem(at: proxy)
-                }
-
-                try FileManager.default.createSymbolicLink(
-                    atPath: proxy.path,
-                    withDestinationPath: proxyTo
-                )
-            }
-        }
-
         if overwrite || !FileManager.default.fileExists(atPath: envFile.path) {
             SwiftlyCore.print("Creating shell environment file for the user...")
             var env = ""
@@ -251,10 +227,11 @@ internal struct Init: SwiftlyCommand {
             }
 
             var postInstall: String?
+            var pathChanged: Bool = false
 
             if !skipInstall {
                 let latestVersion = try await Install.resolve(config: config, selector: ToolchainSelector.latest)
-                postInstall = try await Install.execute(version: latestVersion, &config, useInstalledToolchain: true, verifySignature: true, verbose: verbose)
+                (postInstall, pathChanged) = try await Install.execute(version: latestVersion, &config, useInstalledToolchain: true, verifySignature: true, verbose: verbose, assumeYes: assumeYes)
             }
 
             if addEnvToProfile {
@@ -265,17 +242,15 @@ internal struct Init: SwiftlyCommand {
                     \(sourceLine)
 
                 """)
+            }
 
-#if os(macOS)
+            if pathChanged {
                 SwiftlyCore.print("""
-                NOTE: On macOS it is possible that the shell will pick up the system Swift on the path
-                instead of the one that swiftly has installed for you. You can run this command to update
-                the shell with the latest PATHs.
+                Your shell caches items on your path for better performance. Swiftly has added items to your path that may not get picked up right away. You can run this command to update your shell to get these items.
 
-                hash -r
+                    hash -r
 
                 """)
-#endif
             }
 
             if let postInstall {
@@ -284,7 +259,7 @@ internal struct Init: SwiftlyCommand {
                 You can run the following script as the system administrator (e.g. root) to prepare
                 your system:
 
-                \(postInstall)
+                    \(postInstall)
 
                 """)
             }