Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add task definitions for just as alternative command runner #127

Merged
merged 8 commits into from
Feb 10, 2025
+225 −16
Merged

Add task definitions for just as alternative command runner #127

Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
340158e
Simplify makefile and config
dalito Jan 7, 2025
e123584
Add a justfile matching the make commands
dalito Jan 7, 2025
82fae5e
Update READMEs for just
dalito Jan 7, 2025
d20d919
Don't parse justfile with cookiecutter
dalito Jan 10, 2025
239051f
Quote values in dotenv file
dalito Jan 10, 2025
846de57
Fixes after testing all commands
dalito Jan 11, 2025
3eb2522
fixup! Simplify makefile and config
dalito Jan 11, 2025
ed1ceb5
Fix pipx install command for just
dalito Jan 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Update READMEs for just
@dalito
dalito committed Jan 11, 2025
commit 82fae5e1ad91e7fe1f418900f924b1567b10fadf
8 changes: 8 additions & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -50,6 +50,14 @@ The following are required and recommended tools for using this cookiecutter and
```
You may also choose to not have a persistent installation of cruft, in which case you would replace any calls to the `cruft` command below with `pipx run cruft`.


* **make or just as command runner**

The project contains a makefile but also a `justfile` with pre-defined complex commands. To execute these commands you either need `make` or [just](https://github.com/casey/just) as an alternative command runner. Especially for Windows users we suggest `just`. Install it by running:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm a little concerned about having two command runners requiring changes in two places and the possibility of their getting out of sync. Do you have a strategy for managing both of these files to avoid that?

Copy link
Member Author

@dalito dalito Jan 8, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes. I agree that having both is not ideal but may be worth an experiment. Some make users may also convert to just but it is difficult to predict.

```shell
pipx install just
```

## Creating a new project

### Step 1: Generate the project files
9 changes: 5 additions & 4 deletions {{cookiecutter.project_name}}/README.md
View file
Original file line number Diff line number Diff line change
@@ -23,10 +23,11 @@
## Developer Documentation

<details>
Use the `make` command to generate project artefacts:

* `make all`: make everything
* `make deploy`: deploys site
To run commands you may use good old make or the command runner [just](https://github.com/casey/just/) which is a better choice on Windows.
Use the `make` command or `duty` commands to generate project artefacts:
* `make help` or `just --list`: list all pre-defined tasks
* `make all` or `just all`: make everything
* `make deploy` or `just deploy`: deploys site
</details>

## Credits