Release/0.5.4

.github/workflows/build.yml

@@ -12,7 +12,7 @@ jobs:
     steps:
       - uses: maxim-lobanov/setup-xcode@v1
         with:
-          xcode-version: '16.2.0' # Specify the desired Xcode version
+          xcode-version: '16.4.0' # Specify the desired Xcode version
 
       - uses: actions/checkout@v4
 

.gitignore

@@ -5,7 +5,7 @@ output/
 /*.xcodeproj
 xcuserdata/
 DerivedData/
-.swiftpm/config/registries.json
+.swiftpm/configuration/registries.json
 .swiftpm/xcode/package.xcworkspace/contents.xcworkspacedata
 .netrc
 .swiftpm

Documentation/releasing_an_update.md

@@ -9,39 +9,26 @@ When you have an update for `gen-ir`, there's a couple things that need to happe
 
 As mentioned in the [Branching Model](branching_model.md), features should be merged into the `develop` branch. You should never merge a feature directly to `main`.
 
-To release a new version of `gen-ir`, create a release branch and open a merge request from the release branch (see the [Branching Model](branching_model.md)) to `main` at the commit point you're wanting to release and to `develop`. Allow any automated check, peer reviews, and - when approved - merge the request.
+To release a new version of `gen-ir`, create a release branch and open a merge request from the release branch (see the [Branching Model](branching_model.md)) to `main`. Allow any automated check, peer reviews, and - when approved - merge the request.  Release version descriptions mm.nn.pp stand for a 2 digit major version, 2 digit minor version, and 2 digit patch version. For example, `0.3.11` is a valid version.
 
 Then, on your local machine:
 
 - Change to `main` and pull the changes
   - `git checkout main && git pull`
 - Create the new tag for the release:
-  - `git tag -a 1.0.0 -m "Gen IR version: 1.0.0`
-  - `git push --tags`
-- Change to `develop` and pull the changes
-  - `git checkout develop && git pull`
-- Recreate the new `develop` tag for the release:
-  - `git tag -d develop && git push --delete origin develop`
-  - `git tag -a develop -m "Gen IR Develop version: <commit hash>`
+  - `git tag -a mm.nn.pp -m "Gen IR version: mm.nn.pp"`
   - `git push --tags`
 
 Then, in the GitHub UI:
 
 - Go to the [Releases](https://github.com/veracode/gen-ir/releases) page
 - Click `Draft a new release`
 - Set the title to the version name
-- From the drop down list, choose your newly created tag
+- From the drop down list, choose your newly created tag from the main branch
 - Click the `Generate release notes` button to create a change log
 - Ensure `Set as the latest release` is checked
 - Click the `Publish` button
 
-- Click `Draft a new release`
-- Set the title to `develop`
-- From the drop down list, choose your newly created `develop` tag
-- Click the `Generate release notes` button to create a change log
-- Ensure `Set as pre-release` is checked
-- Click the `Publish` button
-
 A release has been made, congratulations. However there's additional steps for distributing the release via `brew`.
 
 ## Distributing a release

Sources/DependencyGraph/DependencyGraph.swift

@@ -38,7 +38,7 @@ public class DependencyGraph<Value: NodeValue> {
 	/// - Returns: the chain of nodes, starting with the 'bottom' of the dependency subgraph
 	public func chain(for value: Value) -> [Node] {
 		guard let node = findNode(for: value) else {
-			logger.debug("Couldn't find node for value: \(value.valueName)")
+			GenIRLogger.logger.debug("Couldn't find node for value: \(value.valueName)")
 			return []
 		}
 
@@ -49,26 +49,26 @@ public class DependencyGraph<Value: NodeValue> {
 	/// - Parameter node: the node whose children to search through
 	/// - Returns: an array of nodes ordered by a depth-first search approach
 	private func depthFirstSearch(startingAt node: Node) -> [Node] {
-		logger.debug("----\nSearching for: \(node.value.valueName)")
+		GenIRLogger.logger.debug("----\nSearching for: \(node.value.valueName)")
 		var visited = Set<Node>()
 		var chain = [Node]()
 
 		/// Visits node dependencies and adds them to the chain from the bottom up
 		/// - Parameter node: the node to search through
 		func depthFirst(node: Node) {
-			logger.debug("inserting node: \(node.value.valueName)")
+			GenIRLogger.logger.debug("inserting node: \(node.value.valueName)")
 			visited.insert(node)
 
 			for edge in node.edges where edge.relationship == .dependency {
 				if visited.insert(edge.to).inserted {
-					logger.debug("edge to: \(edge.to)")
+					GenIRLogger.logger.debug("edge to: \(edge.to)")
 					depthFirst(node: edge.to)
 				} else {
-					logger.debug("edge already in visited: \(visited)")
+					GenIRLogger.logger.debug("edge already in visited: \(visited)")
 				}
 			}
 
-			logger.debug("appending to chain: \(node.value.valueName)")
+			GenIRLogger.logger.debug("appending to chain: \(node.value.valueName)")
 			chain.append(node)
 		}
 

Sources/DependencyGraph/DependencyGraphBuilder.swift

@@ -47,7 +47,7 @@ public class DependencyGraphBuilder<Provider: DependencyProviding, Value: NodeVa
 			return existingNode
 		}
 
-		logger.debug("Adding value: \(value.valueName) to graph")
+		GenIRLogger.logger.debug("Adding value: \(value.valueName) to graph")
 
 		let dependencies = provider.dependencies(for: value)
 		let node = graph.addNode(for: value)

Sources/GenIR/BuildCacheManipulator.swift

@@ -114,12 +114,12 @@ struct BuildCacheManipulator {
 		}
 		.reduce(into: [String: URL]()) { $0[$1.lastPathComponent] = $1 }
 
-		logger.debug("symlinks to update: \(symlinksToUpdate)")
-		logger.debug("existing frameworks: \(existingFrameworks)")
+		GenIRLogger.logger.debug("symlinks to update: \(symlinksToUpdate)")
+		GenIRLogger.logger.debug("existing frameworks: \(existingFrameworks)")
 
 		try symlinksToUpdate.forEach { name, path in
 			guard let buildProductPath = existingFrameworks[name] else {
-				logger.error("Couldn't lookup \(name) in existing frameworks: \(existingFrameworks.keys)")
+				GenIRLogger.logger.error("Couldn't lookup \(name) in existing frameworks: \(existingFrameworks.keys)")
 				return
 			}
 
@@ -147,7 +147,7 @@ struct BuildCacheManipulator {
 		}
 
 		// Uh oh, there shouldn't be more than one folder here - was a clean performed?
-		logger.warning(
+		GenIRLogger.logger.warning(
 			"Expected one folder at path: \(path), but got \(folders.count): \(folders). Attempting to select a Debug or Veracode configuration folder"
 		)
 
@@ -161,7 +161,7 @@ struct BuildCacheManipulator {
 		}
 
 		if filtered.count > 1 {
-			logger.error(
+			GenIRLogger.logger.error(
 				"""
 				Found more than one possible folders matching 'debug' or 'veracode' configurations: \(filtered). Please ensure you build from a clean state.
 				"""

Sources/GenIR/CompilerCommandRunner.swift

@@ -54,24 +54,24 @@ struct CompilerCommandRunner {
 		let totalCommands = commands
 			.map { $0.value.count }
 			.reduce(0, +)
-		logger.info("Total commands to run: \(totalCommands)")
+		GenIRLogger.logger.info("Total commands to run: \(totalCommands)")
 
 		var totalModulesRun = 0
 
 		for target in targets {
 			// Continue to the next target if no commands are found for the current target
 			guard let targetCommands = commands[TargetKey(projectName: target.projectName, targetName: target.name)] else {
-				logger.debug("No commands found for target: \(target.name) in project: \(target.projectName)")
+				GenIRLogger.logger.debug("No commands found for target: \(target.name) in project: \(target.projectName)")
 				continue
 			}
 
-			logger.info("Operating on target: \(target.name). Total modules processed: \(totalModulesRun)")
+			GenIRLogger.logger.info("Operating on target: \(target.name). Total modules processed: \(totalModulesRun)")
 
 			totalModulesRun += try run(commands: targetCommands, for: target.productName, at: output)
 		}
 
 		let uniqueModules = Set(try fileManager.files(at: output, withSuffix: ".bc")).count
-		logger.info("Finished compiling all targets. Unique modules: \(uniqueModules)")
+		GenIRLogger.logger.info("Finished compiling all targets. Unique modules: \(uniqueModules)")
 	}
 
 	/// Runs all commands for a given target
@@ -85,12 +85,12 @@ struct CompilerCommandRunner {
 		let targetDirectory = directory.appendingPathComponent(name)
 
 		try fileManager.createDirectory(at: targetDirectory, withIntermediateDirectories: true)
-		logger.debug("Created target directory: \(targetDirectory)")
+		GenIRLogger.logger.debug("Created target directory: \(targetDirectory)")
 
 		var targetModulesRun = 0
 
 		for (index, command) in commands.enumerated() {
-			logger.info(
+			GenIRLogger.logger.info(
 				"""
 				\(dryRun ? "Dry run of" : "Running") command (\(command.compiler.rawValue)) \(index + 1) of \(commands.count). \
 				Target modules processed: \(targetModulesRun)
@@ -106,7 +106,7 @@ struct CompilerCommandRunner {
 			do {
 				result = try Process.runShell(executable, arguments: arguments, runInDirectory: directory)
 			} catch {
-				logger.error(
+				GenIRLogger.logger.error(
 					"""
 					Couldn't create process for executable: \(executable) with arguments: \(arguments.joined(separator: " ")). \
 					This is likely a bug in parsing the build log. Please raise it as an issue.
@@ -122,7 +122,7 @@ struct CompilerCommandRunner {
 						continue
 					}
 				}
-				logger.error(
+				GenIRLogger.logger.error(
 				"""
 				Command finished:
 					- code: \(result.code)
@@ -141,7 +141,7 @@ struct CompilerCommandRunner {
 			switch command.compiler {
 			case .swiftc:
 				guard let outputFileMap = try getOutputFileMap(from: arguments) else {
-					logger.error("Failed to find OutputFileMap for command \(command.command) ")
+					GenIRLogger.logger.error("Failed to find OutputFileMap for command \(command.command) ")
 					break
 				}
 
@@ -151,7 +151,7 @@ struct CompilerCommandRunner {
 			}
 
 			if clangAdditionalModules == 0 && swiftAdditionalModules == 0 {
-				logger.error(
+				GenIRLogger.logger.error(
 					"""
 					No modules were produced from compiler, potential failure. Results: \n\n \
 					executable: \(executable)\n\n \
@@ -290,8 +290,8 @@ extension CompilerCommandRunner {
 		let path = arguments[index + 1].fileURL
 
 		guard fileManager.fileExists(atPath: path.filePath) else {
-			logger.error("Found an OutputFileMap, but it doesn't exist on disk? Please report this issue.")
-			logger.debug("OutputFileMap path: \(path)")
+			GenIRLogger.logger.error("Found an OutputFileMap, but it doesn't exist on disk? Please report this issue.")
+			GenIRLogger.logger.debug("OutputFileMap path: \(path)")
 			return nil
 		}