feat!: migrating from Makefile to Just #7187
Open
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
Apologies about the unrequested change. Opening this as **demo** one of some QoL improvement suggestions for @nellshamrell . It's up to you all do decide :) ## Migrate from Makefile to Justfile This PR converts the existing Makefile to a Justfile for improved developer experience and modern tooling. ### Changes Made **Core Migration:** - Converted all Make targets to Just recipes with equivalent functionality - Updated syntax from Make to Just format (removed `#!/bin/sh`, updated variable references) - Replaced `$(shell pwd)` with `{{justfile_directory()}}` for path resolution - **All original functionalities preserved** - no behavioral changes to existing workflows **Enhanced User Experience:** - Added `help` recipe that displays all available commands with descriptions - Improved recipe descriptions for better clarity in help output - Added project title and essential user information **Container Runtime:** - Renamed `build` → `docker-build` for explicit Docker usage - Fixed directory creation before container execution to prevent volume mount errors **Documentation Updates:** - Updated README.md to reference [Just](https://just.systems/) instead of Make - Changed all command examples from `make` to `just` ### Testing - **Verified `just website` works end-to-end**: Successfully generated 625 articles and hosted local server on port 8000 - **Verified `just email` works end-to-end**: Successfully generated email template `622-2025-10-22-email.html` - **Verified individual email commands**: Both `just generate-email` and `just optimize-email` work correctly as standalone operations - **Verified clean operations**: Both `just clean-website` and `just clean-email` work correctly - All container operations function correctly with the new justfile syntax ### Usage ```bash # Show all available commands just help # Main workflows (same as before) just website # Generate and host website locally just email # Generate and optimize email template just copy-website-contents # Sync to github.io repo # Container build just docker-build # Build Docker image ``` ### Benefits - **Better UX**: Built-in help system with clear command descriptions - **Modern tooling**: Just provides better syntax and features than Make - **Improved reliability**: Fixed volume mounting issues - **Full compatibility**: All existing workflows remain unchanged All existing workflows remain unchanged - users can simply replace `make` with `just` in their commands. Signed-off-by: andreacfromtheapp <[email protected]>
andreacfromtheapp
force-pushed
the
feat-justfile
branch
from
4ccd5bf to
fcef42e
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Apologies about the unrequested change. Opening this as demo one of some QoL improvement suggestions for @nellshamrell . It's up to you all do decide :)
Migrate from Makefile to Justfile
This PR converts the existing Makefile to a Justfile for improved developer experience and modern tooling.
Changes Made
Core Migration:
#!/bin/sh, updated variable references)$(shell pwd)with{{justfile_directory()}}for path resolutionEnhanced User Experience:
helprecipe that displays all available commands with descriptionsContainer Runtime:
build→docker-buildfor explicit Docker usageDocumentation Updates:
maketojustTesting
just websiteworks end-to-end: Successfully generated 625 articles and hosted local server on port 8000just emailworks end-to-end: Successfully generated email template622-2025-10-22-email.htmljust generate-emailandjust optimize-emailwork correctly as standalone operationsjust clean-websiteandjust clean-emailwork correctlyUsage
Benefits
All existing workflows remain unchanged - users can simply replace
makewithjustin their commands.