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 common subcommands to the top-level Justfile #275

Merged
merged 2 commits into from
Aug 2, 2024

Conversation

joshuadavidthomas
Copy link
Member

@joshuadavidthomas joshuadavidthomas commented Aug 2, 2024

closes #205
closes #251

Command Description
bootstrap Prepare local environment by installing dependencies and building Docker containers
clean Delete cache, coverage, and dependency directories and stop and delete Docker containers including volumes
console* Open a bash shell in a Docker container
down Stop docker compose stack
lint Lint project
lock Generate lockfiles for all project tools
logs Print Docker Compose logs
migrate Run Django migrations
makemigrations/mm Generate Django migrations
manage Run Django management command
refresh** Bring down Docker Compose stack, bootstrap local environment, and start Docker Compose stack in the background
setup Clean and bootstrap local environment, start Docker Compose stack, run Django migrations and create superuser account, and run tests, type checkers, and linters
shell* Open a Docker container's runtime console (e.g. a Python REPL, psql, etc.)
start Start the Docker Compose stack in the background
stop Stop the Docker Compose stack
tail Follow the Docker Compose logs
test Run all project tests, including generating code coverage
up Start the Docker Compose stack in the foreground
update Pull latest Docker images, lock Python and Node dependencies, and bootstrap local environment
upgrade Bump dependencies to latest versions

Breaking Changes

*console and shell commands have been swapped
**server command has been renamed to refresh and changed to starting the compose stack detached at the end, instead of in the foreground

@joshuadavidthomas joshuadavidthomas marked this pull request as ready for review August 2, 2024 22:09
@joshuadavidthomas joshuadavidthomas requested a review from a team as a code owner August 2, 2024 22:09
@joshuadavidthomas joshuadavidthomas merged commit e2b1d21 into main Aug 2, 2024
6 checks passed
@joshuadavidthomas joshuadavidthomas deleted the add-top-level-commands branch August 2, 2024 22:51
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.

Swap console and shell Just commands Add back some common Justfile commands to top-level
1 participant