refactor: move main.go to cmd/jail for standard Go project layout #13
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Updated all build tooling to work with the moved main.go: ## Files Updated ### Makefile - Updated build target: ./cmd/jail instead of . - Updated build-all target: all cross-platform builds use ./cmd/jail - Version injection still works with -X main.version= ### Build Script (scripts/build.sh) - Updated to build from ./cmd/jail directory - All platform builds now use correct path ### GitHub Actions Workflows - build.yml: Updated build command to use ./cmd/jail - release.yml: Updated build command to use ./cmd/jail - Version injection path remains main.version (package didn't change) ### README.md - Updated build examples: go build -o jail ./cmd/jail - Updated development section manual commands - Updated Quick Start build example ## Tested - ✅ make build works correctly - ✅ ./scripts/build.sh creates all 4 binaries - ✅ Version injection works (dev-dd5ba1d) - ✅ Cross-platform builds succeed - ✅ Tests run (though some may have existing issues) ## Compatibility All existing workflows and build processes continue to work with the new cmd/jail project structure. The change is fully backward compatible from a user perspective. Co-authored-by: f0ssel <[email protected]>
blink-so
bot
changed the title
Moved jail logic from CLI into a reusable library interface: - jail.Config struct with all configuration options - jail.Jail struct representing a jail instance - jail.New() constructor - jail.Start(), Execute(), Run(), Stop() methods Simplified CLI to use the jail package as a thin wrapper. Maintained full CLI compatibility while enabling library usage. Co-authored-by: f0ssel <[email protected]>
blink-so
bot
changed the title
Simplified the jail package interface by removing the Run() method: ## Changes - Removed jail.Run() convenience method from jail.go - Updated CLI to use explicit Start() -> Execute() -> Stop() pattern - Added proper defer j.Stop() for cleanup in CLI ## Rationale Keeping the interface explicit and minimal: - Start() - Initialize the jail environment - Execute() - Run command in jail (requires Start() first) - Stop() - Cleanup resources This makes the lifecycle clear and gives users full control over when initialization and cleanup happen. ## Usage Pattern Co-authored-by: f0ssel <[email protected]>
This reverts commit a4951b1.
This reverts commit b0e7507.
blink-so
bot
changed the title
The empty jail.go file was causing Go tests to fail with: 'expected 'package', found 'EOF'' Removed the 0-byte file to fix test execution. All tests now pass and build continues to work. Fixes test failures in the root package. Co-authored-by: f0ssel <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Overview
Refactors the project to use the standard Go project layout by moving the main executable to
cmd/jail/and updating all build tooling to work with the new structure.Changes Made
Project Structure
main.go→cmd/jail/main.go(standard Go layout).gitignoreto removejailandjail.exeentriesjail.gofile that was causing test failuresBuild Tooling Updates
./cmd/jailscripts/build.shfor new structure./cmd/jailBenefits
cmd/Compatibility
-X main.version=Testing
make build- Creates binary correctly./scripts/build.sh- All 4 platforms build successfullygo test ./...- All tests pass without failuresdev-9829aba)This refactor modernizes the project structure while maintaining full backward compatibility for all build processes and workflows.
Commit History Notes
This PR includes some reverted commits where I initially added a jail package interface but then reverted those changes per feedback. The final state only includes the structural refactor (cmd/jail) and build tooling updates, keeping the original CLI implementation intact.