kopia lustrzana https://github.com/wagtail/docker-wagtail-develop
Replace docker-compose with docker compose
rodzic
fc46c3eaec
commit
10b77d4b65
34
Makefile
34
Makefile
|
@ -8,46 +8,46 @@ help: ## ⁉️ - Display help comments for each make command
|
|||
| sort
|
||||
|
||||
build: ## Build the backend Docker image
|
||||
docker-compose build web
|
||||
docker compose build web
|
||||
|
||||
start: ## Bring the backend Docker container up
|
||||
docker-compose up
|
||||
docker compose up
|
||||
|
||||
stop: ## Stop the backend Docker container
|
||||
docker-compose stop
|
||||
docker compose stop
|
||||
|
||||
ssh: ## Enter the running backend Docker container for the wagtail bakery site
|
||||
docker-compose exec web bash
|
||||
docker compose exec web bash
|
||||
|
||||
ssh-shell: ## Enter the running Docker container shell
|
||||
docker-compose exec web python manage.py shell
|
||||
docker compose exec web python manage.py shell
|
||||
|
||||
ssh-fe: ## Open a shell to work with the frontend code (Node/NPM)
|
||||
docker-compose exec frontend bash
|
||||
docker compose exec frontend bash
|
||||
|
||||
ssh-wagtail: ## Enter the running Docker container for the wagtail development environment
|
||||
docker-compose exec -w /code/wagtail web bash
|
||||
docker compose exec -w /code/wagtail web bash
|
||||
|
||||
ssh-db: ## Open a PostgreSQL shell session
|
||||
docker-compose exec web python manage.py dbshell
|
||||
docker compose exec web python manage.py dbshell
|
||||
|
||||
down: ## Stop and remove all Docker containers
|
||||
docker-compose down
|
||||
docker compose down
|
||||
|
||||
migrations: ## Make migrations to the wagtail bakery site
|
||||
docker-compose exec web python manage.py makemigrations
|
||||
docker compose exec web python manage.py makemigrations
|
||||
|
||||
migrate: ## Migrate the wagtail bakery site migrations
|
||||
docker-compose exec web python manage.py migrate
|
||||
docker compose exec web python manage.py migrate
|
||||
|
||||
test: ## Run all wagtail tests or pass in a file with `make test file=wagtail.admin.tests.test_name`
|
||||
docker-compose exec -w /code/wagtail web python runtests.py $(file) $(FILE)
|
||||
docker compose exec -w /code/wagtail web python runtests.py $(file) $(FILE)
|
||||
|
||||
format-wagtail: ## Format Wagtail repo
|
||||
docker-compose exec -w /code/wagtail web make format-server
|
||||
docker-compose exec frontend make format-client
|
||||
docker compose exec -w /code/wagtail web make format-server
|
||||
docker compose exec frontend make format-client
|
||||
|
||||
lint-wagtail: ## Lint the Wagtail repo (server, client, docs)
|
||||
docker-compose exec -w /code/wagtail web make lint-server
|
||||
docker-compose exec -w /code/wagtail web make lint-docs
|
||||
docker-compose exec frontend make lint-client
|
||||
docker compose exec -w /code/wagtail web make lint-server
|
||||
docker compose exec -w /code/wagtail web make lint-docs
|
||||
docker compose exec frontend make lint-client
|
||||
|
|
46
README.md
46
README.md
|
@ -20,7 +20,7 @@ cd wagtail-dev/
|
|||
# 4. Run the setup script. This will check out the bakerydemo project and local copies of wagtail and its dependencies.
|
||||
./setup.sh
|
||||
# 5. Build the containers
|
||||
docker-compose build
|
||||
docker compose build
|
||||
```
|
||||
|
||||
It can take a while (typically 15-20 minutes) to fetch and build all dependencies and containers.
|
||||
|
@ -38,10 +38,10 @@ Once the build is complete:
|
|||
|
||||
```sh
|
||||
# 6. Start your containers and wait for them to finish their startup scripts.
|
||||
docker-compose up
|
||||
docker compose up
|
||||
```
|
||||
|
||||
You might see a message like this the first time you run your containers. This is normal because the frontend container has not finished building the assets for the Wagtail admin. Just wait a few seconds for the frontend container to finish building (you should see a message like `webpack compiled successfully in 15557 ms` and then stop and start your containers again (Ctrl+C + `docker-compose up`).
|
||||
You might see a message like this the first time you run your containers. This is normal because the frontend container has not finished building the assets for the Wagtail admin. Just wait a few seconds for the frontend container to finish building (you should see a message like `webpack compiled successfully in 15557 ms` and then stop and start your containers again (Ctrl+C + `docker compose up`).
|
||||
|
||||
````
|
||||
WARNINGS:
|
||||
|
@ -64,7 +64,7 @@ WARNINGS:
|
|||
If you're running this on Linux you might get into some privilege issues that can be solved using this command (tested on Ubuntu):
|
||||
|
||||
```sh
|
||||
CURRENT_UID=$(id -u):$(id -g) docker-compose -f docker-compose.yml -f docker-compose.linux.yml up
|
||||
CURRENT_UID=$(id -u):$(id -g) docker compose -f docker-compose.yml -f docker-compose.linux.yml up
|
||||
```
|
||||
|
||||
Alternatively, if you're using VSCode and have the "Remote - Containers" extension, you can open the command palette and select "Remote Containers - Reopen in Container" to attach VSCode to the container. This allows for much deeper debugging.
|
||||
|
@ -77,7 +77,7 @@ Alternatively, if you're using VSCode and have the "Remote - Containers" extensi
|
|||
### See a list of running containers
|
||||
|
||||
```sh
|
||||
$ docker-compose ps
|
||||
$ docker compose ps
|
||||
Name Command State Ports
|
||||
--------------------------------------------------------------------------
|
||||
db docker-entrypoint.sh postgres Up 5432/tcp
|
||||
|
@ -94,7 +94,7 @@ make build
|
|||
or
|
||||
|
||||
```sh
|
||||
docker-compose build web
|
||||
docker compose build web
|
||||
```
|
||||
|
||||
### Bring the backend Docker container up
|
||||
|
@ -106,7 +106,7 @@ make start
|
|||
or
|
||||
|
||||
```sh
|
||||
docker-compose up
|
||||
docker compose up
|
||||
```
|
||||
|
||||
### Stop all Docker containers
|
||||
|
@ -118,7 +118,7 @@ make stop
|
|||
or
|
||||
|
||||
```sh
|
||||
docker-compose stop
|
||||
docker compose stop
|
||||
```
|
||||
|
||||
### Stop all and remove all Docker containers
|
||||
|
@ -130,7 +130,7 @@ make down
|
|||
or
|
||||
|
||||
```sh
|
||||
docker-compose down
|
||||
docker compose down
|
||||
```
|
||||
|
||||
### Run tests
|
||||
|
@ -142,7 +142,7 @@ make test
|
|||
or
|
||||
|
||||
```sh
|
||||
docker-compose exec -w /code/wagtail web python runtests.py
|
||||
docker compose exec -w /code/wagtail web python runtests.py
|
||||
```
|
||||
|
||||
### Run tests for a specific file
|
||||
|
@ -154,7 +154,7 @@ make test file=wagtail.admin.tests.test_name
|
|||
or
|
||||
|
||||
```sh
|
||||
docker-compose exec -w /code/wagtail web python runtests.py wagtail.admin.tests.{test_file_name_here}
|
||||
docker compose exec -w /code/wagtail web python runtests.py wagtail.admin.tests.{test_file_name_here}
|
||||
```
|
||||
|
||||
### Format Wagtail codebase
|
||||
|
@ -164,8 +164,8 @@ make format-wagtail
|
|||
```
|
||||
or
|
||||
```sh
|
||||
docker-compose exec -w /code/wagtail web make format-server
|
||||
docker-compose exec frontend make format-client
|
||||
docker compose exec -w /code/wagtail web make format-server
|
||||
docker compose exec frontend make format-client
|
||||
```
|
||||
|
||||
### Lint Wagtail codebase
|
||||
|
@ -175,9 +175,9 @@ make lint-wagtail
|
|||
```
|
||||
or
|
||||
```sh
|
||||
docker-compose exec -w /code/wagtail web make lint-server
|
||||
docker-compose exec -w /code/wagtail web make lint-docs
|
||||
docker-compose exec frontend make lint-client
|
||||
docker compose exec -w /code/wagtail web make lint-server
|
||||
docker compose exec -w /code/wagtail web make lint-docs
|
||||
docker compose exec frontend make lint-client
|
||||
```
|
||||
|
||||
### Open a Django shell session
|
||||
|
@ -189,7 +189,7 @@ make ssh-shell
|
|||
or
|
||||
|
||||
```sh
|
||||
docker-compose exec web python manage.py shell
|
||||
docker compose exec web python manage.py shell
|
||||
```
|
||||
|
||||
### Open a PostgreSQL shell session
|
||||
|
@ -201,7 +201,7 @@ make ssh-db
|
|||
or
|
||||
|
||||
```sh
|
||||
docker-compose exec web python manage.py dbshell
|
||||
docker compose exec web python manage.py dbshell
|
||||
```
|
||||
|
||||
### Open a shell on the web server
|
||||
|
@ -213,7 +213,7 @@ make ssh
|
|||
or
|
||||
|
||||
```sh
|
||||
docker-compose exec web bash
|
||||
docker compose exec web bash
|
||||
```
|
||||
|
||||
### Open a shell to work with the frontend code (Node/NPM)
|
||||
|
@ -225,7 +225,7 @@ make ssh-fe
|
|||
or
|
||||
|
||||
```sh
|
||||
docker-compose exec frontend bash
|
||||
docker compose exec frontend bash
|
||||
```
|
||||
|
||||
### Open a shell to work within the wagtail container
|
||||
|
@ -237,7 +237,7 @@ make ssh-fe
|
|||
or
|
||||
|
||||
```sh
|
||||
docker-compose exec -w /code/wagtail web bash
|
||||
docker compose exec -w /code/wagtail web bash
|
||||
```
|
||||
|
||||
### Make migrations to the wagtail bakery site
|
||||
|
@ -249,7 +249,7 @@ make migrations
|
|||
or
|
||||
|
||||
```sh
|
||||
docker-compose exec web python manage.py makemigrations
|
||||
docker compose exec web python manage.py makemigrations
|
||||
```
|
||||
|
||||
### Migrate the wagtail bakery site
|
||||
|
@ -261,7 +261,7 @@ make migrate
|
|||
or
|
||||
|
||||
```sh
|
||||
docker-compose exec web python manage.py migrate
|
||||
docker compose exec web python manage.py migrate
|
||||
```
|
||||
|
||||
## Getting ready to contribute
|
||||
|
|
|
@ -3,6 +3,6 @@
|
|||
# Fail if any command fails.
|
||||
set -e
|
||||
|
||||
docker-compose exec web python manage.py migrate --noinput
|
||||
docker-compose exec web python manage.py load_initial_data
|
||||
docker-compose exec web python manage.py update_index
|
||||
docker compose exec web python manage.py migrate --noinput
|
||||
docker compose exec web python manage.py load_initial_data
|
||||
docker compose exec web python manage.py update_index
|
||||
|
|
Ładowanie…
Reference in New Issue