Implement versioning and build enhancements with cross-platform support

Author: kjanat

.github/workflows/ci.yml

@@ -12,6 +12,8 @@ jobs:
   test:
     name: Test
     runs-on: ubuntu-latest
+    permissions:
+      contents: write
     strategy:
       matrix:
         go: [1.21.x, 1.22.x, 1.23.x, 1.24.x]
@@ -105,18 +107,37 @@ jobs:
 
       - name: Build binaries
         run: |
-          # Build for different platforms
-          OS = ["darwin", "freebsd", "linux", "windows"]
-          ARCH = ["amd64", "arm64"]
+          # Set the build time environment variable
+          BUILD_TIME=$(date -u +'%Y-%m-%dT%H:%M:%SZ')
+
+          # Add run permissions to the build script
+          chmod +x ./scripts/build.sh
 
-          for os in OS:
-            for arch in ARCH:
-              GOOS=$os GOARCH=$arch go build -o articulate-parser-$os-$arch main.go
+          # Display help information for the build script
+          ./scripts/build.sh --help
+
+          # Build for all platforms
+          ./scripts/build.sh \
+            --verbose \
+            -ldflags "-s -w -X github.com/kjanat/articulate-parser/internal/version.Version=${{ github.ref_name }} -X github.com/kjanat/articulate-parser/internal/version.BuildTime=$BUILD_TIME -X github.com/kjanat/articulate-parser/internal/version.GitCommit=${{ github.sha }}"
+
+      - name: Upload a Build Artifact
+        uses: actions/[email protected]
+        with:
+          # Artifact name
+          name: build-artifacts # optional, default is artifact
+          # A file, directory or wildcard pattern that describes what to upload
+          path: build/
+          if-no-files-found: ignore
+          retention-days: 1
+          compression-level: 9
+          overwrite: true
+          include-hidden-files: true
 
       - name: Create Release
         uses: softprops/action-gh-release@v2
         with:
-          files: articulate-parser-*
+          files: build/*
           generate_release_notes: true
           draft: false
           prerelease: ${{ startsWith(github.ref, 'refs/tags/v0.') }}

.gitignore

@@ -30,3 +30,7 @@ go.work
 output/
 articulate-sample.json
 test-output.*
+go-os-arch-matrix.csv
+
+# Build artifacts
+build/

internal/version/version.go

@@ -0,0 +1,15 @@
+// Package version provides version information for the Articulate Parser.
+// It includes the current version, build time, and Git commit hash.
+package version
+
+// Version information.
+var (
+	// Version is the current version of the application.
+	Version = "0.1.0"
+
+	// BuildTime is the time the binary was built.
+	BuildTime = "unknown"
+
+	// GitCommit is the git commit hash.
+	GitCommit = "unknown"
+)

main.go

@@ -14,6 +14,8 @@ import (
 	"time"
 
 	"github.com/unidoc/unioffice/document"
+
+	"github.com/kjanat/articulate-parser/internal/version"
 )
 
 // Core data structures based on the Articulate Rise JSON format
@@ -547,8 +549,17 @@ func (p *ArticulateParser) processItemToDocx(doc *document.Document, item Item)
 }
 
 func main() {
+	// Handle version flag
+	if len(os.Args) > 1 && (os.Args[1] == "-v" || os.Args[1] == "--version") {
+		fmt.Printf("articulate-parser %s\n", version.Version)
+		fmt.Printf("Build time: %s\n", version.BuildTime)
+		fmt.Printf("Commit: %s\n", version.GitCommit)
+		os.Exit(0)
+	}
+
 	if len(os.Args) < 3 {
 		fmt.Println("Usage: articulate-parser <input_uri_or_file> <output_format> [output_path]")
+		fmt.Println("       articulate-parser -v|--version")
 		fmt.Println("  input_uri_or_file: Articulate Rise URI or local JSON file path")
 		fmt.Println("  output_format: md (Markdown) or docx (Word Document)")
 		fmt.Println("  output_path: Optional output file path")

scripts/_build_tools_available.ps1

@@ -0,0 +1,38 @@
+param(
+	[switch]$AsCheckmark
+)
+
+# Get the list from 'go tool dist list'
+$dists = & go tool dist list
+
+# Parse into OS/ARCH pairs
+$parsed = $dists | ForEach-Object {
+	$split = $_ -split '/'
+	[PSCustomObject]@{ OS = $split[0]; ARCH = $split[1] }
+}
+
+# Find all unique OSes and arches, sorted
+$oses = $parsed | Select-Object -ExpandProperty OS -Unique | Sort-Object
+$arches = $parsed | Select-Object -ExpandProperty ARCH -Unique | Sort-Object
+
+# Group by OS, and build custom objects
+$results = foreach ($os in $oses) {
+	$props = @{}
+	$props.OS = $os
+	foreach ($arch in $arches) {
+		$hasArch = $parsed | Where-Object { $_.OS -eq $os -and $_.ARCH -eq $arch }
+		if ($hasArch) {
+			if ($AsCheckmark) {
+				$props[$arch] = '✅'
+			} else {
+				$props[$arch] = $true
+			}
+		} else {
+			$props[$arch] = $false
+		}
+	}
+	[PSCustomObject]$props
+}
+
+# Output
+$results | Format-Table -AutoSize