mirror
/
docker-wagtail-develop
kopia lustrzana https://github.com/wagtail/docker-wagtail-develop
1
0
Forkuj 0
Kod Zgłoszenia Packages Projekty Wydania Wiki Aktywność

Replace docker-compose with docker compose

pull/78/head
Cynthia Kiser 2024-08-25 16:07:47 -07:00
rodzic be278515b1
commit 0182ebd041
3 zmienionych plików z 43 dodań i 43 usunięć
Pokaż statystyki Ściągnij plik aktualizacji Ściągnij plik porównania Expand all files Collapse all files

34
Makefile
Wyświetl plik

@ -8,46 +8,46 @@ help: ## ⁉️ - Display help comments for each make command
| sort | sort
build: ## Build the backend Docker image build: ## Build the backend Docker image
docker-compose build web docker compose build web
start: ## Bring the backend Docker container up start: ## Bring the backend Docker container up
docker-compose up docker compose up
stop: ## Stop the backend Docker container stop: ## Stop the backend Docker container
docker-compose stop docker compose stop
ssh: ## Enter the running backend Docker container for the wagtail bakery site 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 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) 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 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 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 down: ## Stop and remove all Docker containers
docker-compose down docker compose down
migrations: ## Make migrations to the wagtail bakery site 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 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` 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 format-wagtail: ## Format Wagtail repo
docker-compose exec -w /code/wagtail web make format-server docker compose exec -w /code/wagtail web make format-server
docker-compose exec frontend make format-client docker compose exec frontend make format-client
lint-wagtail: ## Lint the Wagtail repo (server, client, docs) 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-server
docker-compose exec -w /code/wagtail web make lint-docs docker compose exec -w /code/wagtail web make lint-docs
docker-compose exec frontend make lint-client docker compose exec frontend make lint-client

46
README.md
Wyświetl plik

@ -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. # 4. Run the setup script. This will check out the bakerydemo project and local copies of wagtail and its dependencies.
./setup.sh ./setup.sh
# 5. Build the containers # 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. 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 ```sh
# 6. Start your containers and wait for them to finish their startup scripts. # 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: 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): 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 ```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. 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 ### See a list of running containers
```sh ```sh
$ docker-compose ps $ docker compose ps
Name Command State Ports Name Command State Ports
-------------------------------------------------------------------------- --------------------------------------------------------------------------
db docker-entrypoint.sh postgres Up 5432/tcp db docker-entrypoint.sh postgres Up 5432/tcp
@ -94,7 +94,7 @@ make build
or or
```sh ```sh
docker-compose build web docker compose build web
``` ```
### Bring the backend Docker container up ### Bring the backend Docker container up
@ -106,7 +106,7 @@ make start
or or
```sh ```sh
docker-compose up docker compose up
``` ```
### Stop all Docker containers ### Stop all Docker containers
@ -118,7 +118,7 @@ make stop
or or
```sh ```sh
docker-compose stop docker compose stop
``` ```
### Stop all and remove all Docker containers ### Stop all and remove all Docker containers
@ -130,7 +130,7 @@ make down
or or
```sh ```sh
docker-compose down docker compose down
``` ```
### Run tests ### Run tests
@ -142,7 +142,7 @@ make test
or or
```sh ```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 ### Run tests for a specific file
@ -154,7 +154,7 @@ make test file=wagtail.admin.tests.test_name.py
or or
```sh ```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 ### Format Wagtail codebase
@ -164,8 +164,8 @@ make format-wagtail
``` ```
or or
```sh ```sh
docker-compose exec -w /code/wagtail web make format-server docker compose exec -w /code/wagtail web make format-server
docker-compose exec frontend make format-client docker compose exec frontend make format-client
``` ```
### Lint Wagtail codebase ### Lint Wagtail codebase
@ -175,9 +175,9 @@ make lint-wagtail
``` ```
or or
```sh ```sh
docker-compose exec -w /code/wagtail web make lint-server docker compose exec -w /code/wagtail web make lint-server
docker-compose exec -w /code/wagtail web make lint-docs docker compose exec -w /code/wagtail web make lint-docs
docker-compose exec frontend make lint-client docker compose exec frontend make lint-client
``` ```
### Open a Django shell session ### Open a Django shell session
@ -189,7 +189,7 @@ make ssh-shell
or or
```sh ```sh
docker-compose exec web python manage.py shell docker compose exec web python manage.py shell
``` ```
### Open a PostgreSQL shell session ### Open a PostgreSQL shell session
@ -201,7 +201,7 @@ make ssh-db
or or
```sh ```sh
docker-compose exec web python manage.py dbshell docker compose exec web python manage.py dbshell
``` ```
### Open a shell on the web server ### Open a shell on the web server
@ -213,7 +213,7 @@ make ssh
or or
```sh ```sh
docker-compose exec web bash docker compose exec web bash
``` ```
### Open a shell to work with the frontend code (Node/NPM) ### Open a shell to work with the frontend code (Node/NPM)
@ -225,7 +225,7 @@ make ssh-fe
or or
```sh ```sh
docker-compose exec frontend bash docker compose exec frontend bash
``` ```
### Open a shell to work within the wagtail container ### Open a shell to work within the wagtail container
@ -237,7 +237,7 @@ make ssh-fe
or or
```sh ```sh
docker-compose exec -w /code/wagtail web bash docker compose exec -w /code/wagtail web bash
``` ```
### Make migrations to the wagtail bakery site ### Make migrations to the wagtail bakery site
@ -249,7 +249,7 @@ make migrations
or or
```sh ```sh
docker-compose exec web python manage.py makemigrations docker compose exec web python manage.py makemigrations
``` ```
### Migrate the wagtail bakery site ### Migrate the wagtail bakery site
@ -261,7 +261,7 @@ make migrate
or or
```sh ```sh
docker-compose exec web python manage.py migrate docker compose exec web python manage.py migrate
``` ```
## Getting ready to contribute ## Getting ready to contribute

6
setup-db.sh
Wyświetl plik

@ -3,6 +3,6 @@
# Fail if any command fails. # Fail if any command fails.
set -e set -e
docker-compose exec web python manage.py migrate --noinput 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 load_initial_data
docker-compose exec web python manage.py update_index docker compose exec web python manage.py update_index