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.

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 justfile for use with docker #5621

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

earthcomfy
Copy link

@earthcomfy earthcomfy commented Jan 3, 2025

Description

Set up just to simplify calling docker commands.

Checklist:

  • I've made sure that tests are updated accordingly (especially if adding or updating a template option)
  • I've updated the documentation or confirm that my change doesn't require any updates

Rationale

It helps to run frequent commands quicker. This PR attempted to do this via MakeFile. However, using just seems like a better approach, especially since it is a cross-platform tool (can be installed via pip), as mentioned in this comment as well.

@luzfcb
Copy link
Collaborator

luzfcb commented Jan 3, 2025

I like just, but it still doesn't handle SIGNALS behavior very well: casey/just#2473

This pull-request seems good enough for development, however, it should be clear that expanding its use to production can in some cases lead to strange behaviors in signal management between just and the application that is executed with the help of just

@earthcomfy
Copy link
Author

Thanks for the quick reply. I wasn't aware of the bug. I intended this for local development hence it is using the local compose file.

Copy link
Member

@browniebroke browniebroke left a comment

Choose a reason for hiding this comment

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

Yes, would be a nice addition.

Could you please add a paragraph about it in the documentation about local Docker development (under tips & tricks) or -even better- update all docker compose ... commands to their justfile equivalent?

{{cookiecutter.project_slug}}/justfile Outdated Show resolved Hide resolved
@earthcomfy
Copy link
Author

@browniebroke I have added the relevant docs too. Let me know if there is anything missing. Thanks.

@browniebroke
Copy link
Member

That looks good from my perspective

@luzfcb it's documented as being for local development in our docs. Are you hapy with that or do you think we should make the limitations more prominent in the file itself?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants