Update release workflow and build scripts for version 0.1.1

rafabd1 · rafabd1 · commit d1ceee5e4518 · 2025-03-28T01:43:14.000-03:00
- Improved version command output with build date and git commit
- Enhanced build process for all platforms with proper ldflags
- Updated release creation step to include detailed changelog
- Added changelog file for version history
- Updated README to include link to changelog
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -16,6 +16,8 @@ jobs:
     steps:
       - name: Checkout code
         uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
         
       - name: Set up Go
         uses: actions/setup-go@v4
@@ -24,42 +26,65 @@ jobs:
           
       - name: Get version from tag
         id: get_version
-        run: echo "VERSION=${GITHUB_REF#refs/tags/}" >> $GITHUB_ENV
+        run: echo "VERSION=${GITHUB_REF#refs/tags/v}" >> $GITHUB_ENV
         
       - name: Build for all platforms
         run: |
-          # Create build directories
-          mkdir -p dist
+          BUILD_DATE=$(date -u '+%Y-%m-%d %H:%M:%S UTC')
+          GIT_COMMIT=$(git rev-parse --short HEAD)
           
-          # Set build flags
-          BUILD_FLAGS="-s -w -X github.com/rafabd1/SecretHound/cmd.Version=${VERSION} -X github.com/rafabd1/SecretHound/cmd.BuildDate=$(date -u +%Y-%m-%d) -X github.com/rafabd1/SecretHound/cmd.GitCommit=${GITHUB_SHA}"
+          # Build for Windows
+          GOOS=windows GOARCH=amd64 go build -ldflags "-X github.com/rafabd1/SecretHound/cmd.Version=${{ env.VERSION }} -X 'github.com/rafabd1/SecretHound/cmd.BuildDate=${BUILD_DATE}' -X github.com/rafabd1/SecretHound/cmd.GitCommit=${GIT_COMMIT}" -o secrethound-${{ env.VERSION }}-windows-amd64.exe ./cmd/secrethound/
           
           # Build for Linux
-          GOOS=linux GOARCH=amd64 go build -ldflags="${BUILD_FLAGS}" -o dist/secrethound-linux-amd64 ./cmd/secrethound
-          
-          # Build for Windows
-          GOOS=windows GOARCH=amd64 go build -ldflags="${BUILD_FLAGS}" -o dist/secrethound-windows-amd64.exe ./cmd/secrethound
+          GOOS=linux GOARCH=amd64 go build -ldflags "-X github.com/rafabd1/SecretHound/cmd.Version=${{ env.VERSION }} -X 'github.com/rafabd1/SecretHound/cmd.BuildDate=${BUILD_DATE}' -X github.com/rafabd1/SecretHound/cmd.GitCommit=${GIT_COMMIT}" -o secrethound-${{ env.VERSION }}-linux-amd64 ./cmd/secrethound/
           
           # Build for macOS
-          GOOS=darwin GOARCH=amd64 go build -ldflags="${BUILD_FLAGS}" -o dist/secrethound-darwin-amd64 ./cmd/secrethound
-          
-          # Create checksums
-          cd dist
-          sha256sum secrethound-linux-amd64 secrethound-windows-amd64.exe secrethound-darwin-amd64 > checksums.txt
-          cd ..
-          
+          GOOS=darwin GOARCH=amd64 go build -ldflags "-X github.com/rafabd1/SecretHound/cmd.Version=${{ env.VERSION }} -X 'github.com/rafabd1/SecretHound/cmd.BuildDate=${BUILD_DATE}' -X github.com/rafabd1/SecretHound/cmd.GitCommit=${GIT_COMMIT}" -o secrethound-${{ env.VERSION }}-darwin-amd64 ./cmd/secrethound/
+
       - name: Create Release
         id: create_release
         uses: softprops/action-gh-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         with:
-          files: |
-            dist/secrethound-linux-amd64
-            dist/secrethound-windows-amd64.exe
-            dist/secrethound-darwin-amd64
-            dist/checksums.txt
-          name: SecretHound ${{ env.VERSION }}
+          name: SecretHound v${{ env.VERSION }}
           draft: false
           prerelease: false
-          generate_release_notes: true
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          files: |
+            secrethound-${{ env.VERSION }}-windows-amd64.exe
+            secrethound-${{ env.VERSION }}-linux-amd64
+            secrethound-${{ env.VERSION }}-darwin-amd64
+          body: |
+            # SecretHound v${{ env.VERSION }}
+            
+            ## Improvements
+            - Removed global execution timeout allowing scans to run without time constraints
+            - Enhanced error logging with better visibility for critical errors
+            - Improved log output reducing redundant messages and clarifying statistics
+            - Fixed build information display in version command
+            - Added proper build date and git commit tracking
+            - Optimized progress display with cleaner output
+            
+            ## Bug Fixes
+            - Fixed issue with timeout prematurely ending large scans
+            - Resolved silent errors in verbose mode
+            
+            ## Installation
+            
+            Download the appropriate binary for your platform and make it executable.
+            
+            For Linux/macOS:
+            ```
+            chmod +x secrethound-${{ env.VERSION }}-linux-amd64
+            ./secrethound-${{ env.VERSION }}-linux-amd64
+            ```
+            
+            For Go users:
+            ```
+            go install github.com/rafabd1/SecretHound/cmd/secrethound@latest
+            ```
+            
+            ## Documentation
+            
+            See the [documentation](https://github.com/rafabd1/SecretHound/tree/main/docs) for details on usage.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,44 @@
+# SecretHound Changelog
+
+## v0.1.1 (2024-07-05)
+
+### Improvements
+- Removed global execution timeout allowing scans to run without time constraints
+- Enhanced error logging with better visibility for critical errors
+- Improved log output reducing redundant messages and clarifying statistics
+- Fixed build information display in version command
+- Added proper build date and git commit tracking
+
+### Bug Fixes
+- Fixed issue with timeout prematurely ending large scans
+- Resolved silent errors in verbose mode
+- Enhanced terminal output coordination for cleaner display
+
+### Technical Changes
+- Added build script with proper ldflags for version information
+- Improved GitHub Actions workflow for releases
+- Updated documentation for clarity and completeness
+
+## v0.1.0 (2024-06-15)
+
+### Core Features
+- Multi-threaded scanning of remote URLs and local files
+- 50+ built-in regex patterns to detect common API keys and secrets
+- Smart request scheduling with domain-aware rate limiting
+- Detection and handling of WAF blocks and rate limits
+- Real-time progress bar with detailed statistics
+- Structured output with context for each discovered secret
+
+### Technical Highlights
+- Concurrent processing architecture for maximum performance
+- Configurable timeout and retry mechanisms
+- Customizable regex patterns via external file
+- Cross-platform support (Windows, macOS, and Linux)
+
+### Getting Started
+Download the appropriate binary for your platform or install via:
+```bash
+go install github.com/rafabd1/SecretHound/cmd/secrethound@latest
+```
+
+Check the README for detailed usage instructions and examples.
diff --git a/README.md b/README.md
@@ -118,6 +118,7 @@ For more detailed information, see the [documentation directory](docs/):
 - [Usage Examples](docs/USAGE.md) - Detailed usage examples
 - [Technical Details](docs/TECHNICAL.md) - Internal architecture and design
 - [Supported Secrets](docs/SUPPORTED_SECRETS.md) - List of secret types detected
+- [Changelog](CHANGELOG.md) - Check the latest updates and version history
 
 ## Contributing
 
diff --git a/build.sh b/build.sh
@@ -1,32 +1,36 @@
 #!/bin/bash
 
 # Build script for SecretHound
+VERSION="0.1.1"
+BUILD_DATE=$(date -u '+%Y-%m-%d %H:%M:%S UTC')
+GIT_COMMIT=$(git rev-parse --short HEAD 2>/dev/null || echo "unknown")
 
-VERSION=$(grep -oP 'Version = "\K[^"]+' cmd/version.go)
-echo "Building SecretHound v$VERSION..."
-
-# Create build directory
-mkdir -p bin
+# Display build info
+echo "Building SecretHound $VERSION"
+echo "Build Date: $BUILD_DATE"
+echo "Git Commit: $GIT_COMMIT"
 
 # Build for current platform
-echo "Building for current platform..."
-go build -o bin/secrethound ./cmd/secrethound
+echo "Building for $(go env GOOS)/$(go env GOARCH)..."
+go build -ldflags "-X github.com/rafabd1/SecretHound/cmd.Version=$VERSION -X 'github.com/rafabd1/SecretHound/cmd.BuildDate=$BUILD_DATE' -X github.com/rafabd1/SecretHound/cmd.GitCommit=$GIT_COMMIT" -o secrethound ./cmd/secrethound/
+
+echo "Build complete: $(pwd)/secrethound"
 
-# Cross-compile for other platforms (optional)
+# Build for all major platforms
 if [ "$1" == "release" ]; then
-    echo "Building release binaries..."
+    echo "Building release binaries for all platforms..."
+    
+    # Create output directory
+    mkdir -p release
     
-    # Linux (64-bit)
-    GOOS=linux GOARCH=amd64 go build -o bin/secrethound-linux-amd64 ./cmd/secrethound
+    # Build for Windows
+    GOOS=windows GOARCH=amd64 go build -ldflags "-X github.com/rafabd1/SecretHound/cmd.Version=$VERSION -X 'github.com/rafabd1/SecretHound/cmd.BuildDate=$BUILD_DATE' -X github.com/rafabd1/SecretHound/cmd.GitCommit=$GIT_COMMIT" -o release/secrethound-$VERSION-windows-amd64.exe ./cmd/secrethound/
     
-    # Windows (64-bit)
-    GOOS=windows GOARCH=amd64 go build -o bin/secrethound-windows-amd64.exe ./cmd/secrethound
+    # Build for Linux
+    GOOS=linux GOARCH=amd64 go build -ldflags "-X github.com/rafabd1/SecretHound/cmd.Version=$VERSION -X 'github.com/rafabd1/SecretHound/cmd.BuildDate=$BUILD_DATE' -X github.com/rafabd1/SecretHound/cmd.GitCommit=$GIT_COMMIT" -o release/secrethound-$VERSION-linux-amd64 ./cmd/secrethound/
     
-    # macOS (64-bit)
-    GOOS=darwin GOARCH=amd64 go build -o bin/secrethound-darwin-amd64 ./cmd/secrethound
+    # Build for macOS
+    GOOS=darwin GOARCH=amd64 go build -ldflags "-X github.com/rafabd1/SecretHound/cmd.Version=$VERSION -X 'github.com/rafabd1/SecretHound/cmd.BuildDate=$BUILD_DATE' -X github.com/rafabd1/SecretHound/cmd.GitCommit=$GIT_COMMIT" -o release/secrethound-$VERSION-darwin-amd64 ./cmd/secrethound/
     
-    echo "Release binaries built in bin/ directory"
-else
-    echo "Built binary in bin/secrethound"
-    echo "Run 'build.sh release' to build for all platforms."
+    echo "Release builds complete in $(pwd)/release/"
 fi
diff --git a/cmd/version.go b/cmd/version.go
@@ -8,23 +8,24 @@ import (
 	"github.com/spf13/cobra"
 )
 
+// Build information
 var (
-	Version   = "0.1.0"
+	Version   = "0.1.1"
 	BuildDate = "undefined"
 	GitCommit = "undefined"
 )
 
 // versionCmd represents the version command
 var versionCmd = &cobra.Command{
 	Use:   "version",
-	Short: "Print the version number of SecretHound",
-	Long:  `Display version information about SecretHound and the system it is running on.`,
-	Run: func(cmd *cobra.Command, args []string) {
-		bold := color.New(color.Bold).SprintFunc()
+	Short: "Print version information",
+	Long:  `Display build, version, and runtime information about SecretHound.`,
+	Run: func(cmd *cobra.Command, args []string) {	
+		// Print version information with colored output
 		cyan := color.New(color.FgCyan).SprintFunc()
 		green := color.New(color.FgGreen).SprintFunc()
 		
-		fmt.Println(bold("SecretHound Version Information"))
+		fmt.Println(cyan("SecretHound Version Information"))
 		fmt.Printf("%s: %s\n", cyan("Version"), green(Version))
 		fmt.Printf("%s: %s\n", cyan("Build Date"), green(BuildDate))
 		fmt.Printf("%s: %s\n", cyan("Git Commit"), green(GitCommit))
@@ -35,4 +36,4 @@ var versionCmd = &cobra.Command{
 
 func init() {
 	rootCmd.AddCommand(versionCmd)
-}
+}
