Add version flag to executables (#141)

apple · Jan 7, 2025 · 25108c4 · 25108c4
1 parent fa9f5e2
commit 25108c4
Show file tree

Hide file tree

Showing 6 changed files with 40 additions and 10 deletions.
diff --git a/Sources/HomomorphicEncryption/Version.swift b/Sources/HomomorphicEncryption/Version.swift
@@ -0,0 +1,29 @@
+// Copyright 2025 Apple Inc. and the Swift Homomorphic Encryption project authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package enum Version {
+    case development(branch: String)
+    case release(major: Int, minor: Int, patch: Int)
+
+    package static let current = Version.development(branch: "main")
+
+    package var description: String {
+        switch self {
+        case let .development(branch):
+            "\(branch)-development"
+        case let .release(major, minor, patch):
+            "\(major).\(minor).\(patch)"
+        }
+    }
+}
diff --git a/Sources/PIRGenerateDatabase/GenerateDatabase.swift b/Sources/PIRGenerateDatabase/GenerateDatabase.swift
@@ -1,4 +1,4 @@
-// Copyright 2024 Apple Inc. and the Swift Homomorphic Encryption project authors
+// Copyright 2024-2025 Apple Inc. and the Swift Homomorphic Encryption project authors
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -60,7 +60,7 @@ extension [UInt8] {
 @main
 struct GenerateDatabaseCommand: ParsableCommand {
     static let configuration: CommandConfiguration = .init(
-        commandName: "PIRGenerateDatabase")
+        commandName: "PIRGenerateDatabase", version: Version.current.description)
 
     @Option(help: "Path to output database. Must end in '.txtpb' or '.binpb'")
     var outputDatabase: String

diff --git a/Sources/PIRProcessDatabase/ProcessDatabase.swift b/Sources/PIRProcessDatabase/ProcessDatabase.swift
@@ -1,4 +1,4 @@
-// Copyright 2024 Apple Inc. and the Swift Homomorphic Encryption project authors
+// Copyright 2024-2025 Apple Inc. and the Swift Homomorphic Encryption project authors
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -296,7 +296,7 @@ struct ResolvedArguments: CustomStringConvertible, Encodable {
 @main
 struct ProcessDatabase: AsyncParsableCommand {
     static let configuration: CommandConfiguration = .init(
-        commandName: "PIRProcessDatabase")
+        commandName: "PIRProcessDatabase", version: Version.current.description)
 
     static let logger = Logger(label: "PIRProcessDatabase")
 

diff --git a/Sources/PIRShardDatabase/ShardDatabase.swift b/Sources/PIRShardDatabase/ShardDatabase.swift
@@ -1,4 +1,4 @@
-// Copyright 2024 Apple Inc. and the Swift Homomorphic Encryption project authors
+// Copyright 2024-2025 Apple Inc. and the Swift Homomorphic Encryption project authors
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -13,6 +13,7 @@
 // limitations under the License.
 
 import ArgumentParser
+import HomomorphicEncryption
 import PrivateInformationRetrieval
 import PrivateInformationRetrievalProtobuf
 
@@ -85,7 +86,7 @@ let discussion =
 @main
 struct ProcessCommand: ParsableCommand {
     static let configuration: CommandConfiguration = .init(
-        commandName: "PIRShardDatabase", discussion: discussion)
+        commandName: "PIRShardDatabase", discussion: discussion, version: Version.current.description)
 
     @Option(help: "path to input PIR database file. Must have extension '.txtpb' or '.binpb'")
     var inputDatabase: String

diff --git a/Sources/PNNSGenerateDatabase/GenerateDatabase.swift b/Sources/PNNSGenerateDatabase/GenerateDatabase.swift
@@ -1,4 +1,4 @@
-// Copyright 2024 Apple Inc. and the Swift Homomorphic Encryption project authors
+// Copyright 2024-2025 Apple Inc. and the Swift Homomorphic Encryption project authors
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -28,7 +28,7 @@ enum VectorTypeArguments: String, CaseIterable, ExpressibleByArgument {
 @main
 struct GenerateDatabaseCommand: ParsableCommand {
     static let configuration: CommandConfiguration = .init(
-        commandName: "PNNSGenerateDatabase")
+        commandName: "PNNSGenerateDatabase", version: Version.current.description)
 
     @Option(help: "Path to output database. Must end in '.txtpb' or '.binpb'.")
     var outputDatabase: String

diff --git a/Sources/PNNSProcessDatabase/ProcessDatabase.swift b/Sources/PNNSProcessDatabase/ProcessDatabase.swift
@@ -1,4 +1,4 @@
-// Copyright 2024 Apple Inc. and the Swift Homomorphic Encryption project authors
+// Copyright 2024-2025 Apple Inc. and the Swift Homomorphic Encryption project authors
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -199,7 +199,7 @@ struct ResolvedArguments: CustomStringConvertible, Encodable {
 @main
 struct ProcessDatabase: ParsableCommand {
     static let configuration: CommandConfiguration = .init(
-        commandName: "PNNSProcessDatabase")
+        commandName: "PNNSProcessDatabase", version: Version.current.description)
 
     static let logger = Logger(label: "PNNSProcessDatabase")