GeezerVison is showing github.com — docs/Makefile at dev · TypeCellOS/docs

Expand file tree

Makefile

Copy path

More file actions

Latest commit

History

517 lines (435 loc) · 17.5 KB

Makefile

Copy path

File metadata and controls

517 lines (435 loc) · 17.5 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

# /!\ /!\ /!\ /!\ /!\ /!\ /!\ DISCLAIMER /!\ /!\ /!\ /!\ /!\ /!\ /!\ /!\

# This Makefile is only meant to be used for DEVELOPMENT purpose as we are

# changing the user id that will run in the container.

# PLEASE DO NOT USE IT FOR YOUR CI/PRODUCTION/WHATEVER...

# /!\ /!\ /!\ /!\ /!\ /!\ /!\ /!\ /!\ /!\ /!\ /!\ /!\ /!\ /!\ /!\ /!\ /!\

# Note to developers:

# While editing this file, please respect the following statements:

# 1. Every variable should be defined in the ad hoc VARIABLES section with a

# relevant subsection

# 2. Every new rule should be defined in the ad hoc RULES section with a

# relevant subsection depending on the targeted service

# 3. Rules should be sorted alphabetically within their section

# 4. When a rule has multiple dependencies, you should:

# - duplicate the rule name to add the help string (if required)

# - write one dependency per line to increase readability and diffs

# 5. .PHONY rule statement should be written after the corresponding rule

# ==============================================================================

# VARIABLES

BOLD := \033[1m

RESET := \033[0m

GREEN := \033[1;32m

# -- Database

DB_HOST = postgresql

DB_PORT = 5432

# -- Docker

# Get the current user ID to use for docker run and docker exec commands

ifeq ($(OS),Windows_NT)

DOCKER_USER := 0:0 # run containers as root on Windows

else

DOCKER_UID := $(shell id -u)

DOCKER_GID := $(shell id -g)

DOCKER_USER := $(DOCKER_UID):$(DOCKER_GID)

endif

COMPOSE = DOCKER_USER=$(DOCKER_USER) docker compose

COMPOSE_E2E = DOCKER_USER=$(DOCKER_USER) docker compose -f compose.yml -f compose-e2e.yml

COMPOSE_DEMO = $(COMPOSE)

COMPOSE_EXEC = $(COMPOSE) exec

COMPOSE_EXEC_APP = $(COMPOSE_EXEC) app-dev

COMPOSE_RUN = $(COMPOSE) run --rm

COMPOSE_RUN_APP = $(COMPOSE_RUN) app-dev

COMPOSE_RUN_CROWDIN = $(COMPOSE_RUN) crowdin crowdin

# -- Backend

MANAGE = $(COMPOSE_RUN_APP) python manage.py

MAIL_YARN = $(COMPOSE_RUN) -w //app/src/mail node yarn

YHUB_SERVICE = yhub

# -- Frontend

PATH_FRONT = ./src/frontend

PATH_FRONT_IMPRESS = $(PATH_FRONT)/apps/impress

# ==============================================================================

# RULES

default: help

data/media:

@mkdir -p data/media

data/static:

@mkdir -p data/static

# RSA keys signing the JWT tokens the services issue: one for the backend, one

# for the collaboration server. Generated locally, never committed: "data/" is

# gitignored. Regenerate one by deleting the file. Both are listed, so a stack

# set up before the collaboration server had a key of its own gets it too.

data/jwt/private.pem:

@bin/generate-jwt-private-key.sh

data/jwt/yhub-private.pem:

@bin/generate-jwt-private-key.sh

# -- Project

create-env-local-files: ## create env.local files in env.d/development

create-env-local-files:

@touch env.d/development/crowdin.local

@touch env.d/development/common.local

@touch env.d/development/postgresql.local

@touch env.d/development/kc_auth.local

@touch env.d/development/kc_postgresql.local

@touch env.d/development/yhub-postgres.local

@touch env.d/development/yhub.local

.PHONY: create-env-local-files

generate-secret-keys:

generate-secret-keys: ## generate the secret keys needed by the dev stack

generate-secret-keys: data/jwt/private.pem data/jwt/yhub-private.pem

@bin/generate-oidc-store-refresh-token-key.sh

.PHONY: generate-secret-keys

pre-bootstrap: \

create-docker-network \

data/media \

data/static \

create-env-local-files \

generate-secret-keys

.PHONY: pre-bootstrap

post-bootstrap: \

migrate \

migrate-yhub \

back-i18n-compile \

mails-install \

mails-build

.PHONY: post-bootstrap

pre-beautiful-bootstrap: ## Display a welcome message before bootstrap

ifeq ($(OS),Windows_NT)

@echo ""

@echo "================================================================================"

@echo ""

@echo " Welcome to Docs - Collaborative Text Editing from La Suite!"

@echo ""

@echo " This will set up your development environment with:"

@echo " - Docker containers for all services"

@echo " - Database migrations and static files"

@echo " - Frontend dependencies and build"

@echo " - Environment configuration files"

@echo ""

@echo " Services will be available at:"

@echo " - Frontend: http://localhost:3000"

@echo " - API: http://localhost:8071"

@echo " - Admin: http://localhost:8071/admin"

@echo ""

@echo "================================================================================"

@echo ""

@echo "Starting bootstrap process..."

else

@echo "$(BOLD)"

@echo "╔══════════════════════════════════════════════════════════════════════════════╗"

@echo "║ ║"

@echo "║ 🚀 Welcome to Docs - Collaborative Text Editing from La Suite ! 🚀 ║"

@echo "║ ║"

@echo "║ This will set up your development environment with : ║"

@echo "║ • Docker containers for all services ║"

@echo "║ • Database migrations and static files ║"

@echo "║ • Frontend dependencies and build ║"

@echo "║ • Environment configuration files ║"

@echo "║ ║"

@echo "║ Services will be available at: ║"

@echo "║ • Frontend: http://localhost:3000 ║"

@echo "║ • API: http://localhost:8071 ║"

@echo "║ • Admin: http://localhost:8071/admin ║"

@echo "║ ║"

@echo "╚══════════════════════════════════════════════════════════════════════════════╝"

@echo "$(RESET)"

@echo "$(GREEN)Starting bootstrap process...$(RESET)"

endif

@echo ""

.PHONY: pre-beautiful-bootstrap

post-beautiful-bootstrap: ## Display a success message after bootstrap

@echo ""

ifeq ($(OS),Windows_NT)

@echo "Bootstrap completed successfully!"

@echo ""

@echo "Next steps:"

@echo " - Visit http://localhost:3000 to access the application"

@echo " - Run 'make help' to see all available commands"

else

@echo "$(GREEN)🎉 Bootstrap completed successfully!$(RESET)"

@echo ""

@echo "$(BOLD)Next steps:$(RESET)"

@echo " • Visit http://localhost:3000 to access the application"

@echo " • Run 'make help' to see all available commands"

endif

@echo ""

.PHONY: post-beautiful-bootstrap

create-docker-network: ## create the docker network if it doesn't exist

@docker network create lasuite-network || true

.PHONY: create-docker-network

bootstrap: ## Prepare the project for local development

bootstrap: \

pre-beautiful-bootstrap \

pre-bootstrap \

build \

post-bootstrap \

run \

demo \

post-beautiful-bootstrap

.PHONY: bootstrap

bootstrap-e2e: ## Prepare Docker production images to be used for e2e tests

bootstrap-e2e: COMPOSE_DEMO = $(COMPOSE_E2E)

bootstrap-e2e: YHUB_SERVICE = yhub-e2e

bootstrap-e2e: \

pre-bootstrap \

build-e2e \

post-bootstrap \

run-e2e \

demo

.PHONY: bootstrap-e2e

# -- Docker/compose

build: cache ?=

build: ## build the project containers

@$(MAKE) build-backend cache=$(cache)

@$(MAKE) build-yhub cache=$(cache)

@$(MAKE) build-yjs-provider cache=$(cache)

@$(MAKE) build-frontend cache=$(cache)

.PHONY: build

build-backend: cache ?=

build-backend: ## build the app-dev container

@$(COMPOSE) build app-dev $(cache)

.PHONY: build-backend

build-yhub: cache ?=

build-yhub: ## build the yhub collaboration server container

@$(COMPOSE) build yhub $(cache)

.PHONY: build-yhub

build-yjs-provider: cache ?=

build-yjs-provider: ## build the y-provider container

@$(COMPOSE) build y-provider-development-converter $(cache)

.PHONY: build-yjs-provider

build-frontend: cache ?=

build-frontend: ## build the frontend container

@$(COMPOSE) build frontend-development $(cache)

.PHONY: build-frontend

build-e2e: cache ?=

build-e2e: ## build the e2e container

@$(MAKE) build-backend cache=$(cache)

@$(COMPOSE_E2E) build yhub-e2e $(cache)

@$(COMPOSE_E2E) build frontend $(cache)

@$(COMPOSE_E2E) build y-provider-converter $(cache)

.PHONY: build-e2e

nginx-frontend: ## build the nginx-frontend container

@$(COMPOSE) up --force-recreate -d nginx-frontend

.PHONY: nginx-frontend

down: ## stop and remove containers, networks, images, and volumes

@$(COMPOSE_E2E) down

.PHONY: down

logs: ## display app-dev logs (follow mode)

@$(COMPOSE) logs -f app-dev

.PHONY: logs

run-backend: ## Start only the backend application and all needed services

@$(MAKE) create-docker-network

@$(MAKE) data/jwt/private.pem

@$(MAKE) data/jwt/yhub-private.pem

@$(COMPOSE) up --force-recreate -d docspec

@$(COMPOSE) up --force-recreate -d celery-dev

@$(COMPOSE) up --force-recreate -d y-provider-development-converter

@$(COMPOSE) up --force-recreate -d yhub

@$(COMPOSE) up --force-recreate -d nginx

.PHONY: run-backend

run: ## start the wsgi (production) and development server

run:

@$(MAKE) run-backend

@$(COMPOSE) up --force-recreate -d frontend-development

.PHONY: run

run-e2e: ## start the e2e server

run-e2e:

@$(MAKE) create-docker-network

@$(MAKE) data/jwt/private.pem

@$(MAKE) data/jwt/yhub-private.pem

@$(COMPOSE) up --force-recreate -d docspec

@$(COMPOSE) up --force-recreate -d celery-dev

@$(COMPOSE_E2E) up --force-recreate -d y-provider-converter

@$(COMPOSE_E2E) up --force-recreate -d yhub-e2e

@$(COMPOSE) up --force-recreate -d nginx

@$(COMPOSE_E2E) up --force-recreate -d frontend

.PHONY: run-e2e

status: ## an alias for "docker compose ps"

@$(COMPOSE_E2E) ps

.PHONY: status

stop: ## stop the development server using Docker

@$(COMPOSE_E2E) stop

.PHONY: stop

# -- Backend

demo: ## flush db then create a demo for load testing purpose

@echo "$(BOLD)Waiting for the backend and the collaboration server (yhub)$(RESET)"

@$(COMPOSE_DEMO) up -d --wait app-dev $(YHUB_SERVICE)

@$(MAKE) resetdb

@$(MANAGE) create_demo

.PHONY: demo

index: ## index all documents to remote search

@$(MANAGE) index

.PHONY: index

# Nota bene: Black should come after isort just in case they don't agree...

lint: ## lint back-end python sources

lint: \

lint-ruff-format \

lint-ruff-check \

lint-pylint

.PHONY: lint

lint-ruff-format: ## format back-end python sources with ruff

@echo 'lint:ruff-format started…'

@$(COMPOSE_RUN_APP) ruff format .

.PHONY: lint-ruff-format

lint-ruff-check: ## lint back-end python sources with ruff

@echo 'lint:ruff-check started…'

@$(COMPOSE_RUN_APP) ruff check . --fix

.PHONY: lint-ruff-check

lint-pylint: ## lint back-end python sources with pylint only on changed files from main

@echo 'lint:pylint started…'

bin/pylint --diff-only=origin/main

.PHONY: lint-pylint

test: ## run project tests

@$(MAKE) test-back-parallel

.PHONY: test

test-back: ## run back-end tests

@args="$(filter-out $@,$(MAKECMDGOALS))" && \

bin/pytest $${args:-${1}}

.PHONY: test-back

test-back-parallel: ## run all back-end tests in parallel

@args="$(filter-out $@,$(MAKECMDGOALS))" && \

bin/pytest -n auto $${args:-${1}}

.PHONY: test-back-parallel

makemigrations: ## run django makemigrations for the impress project.

@echo "$(BOLD)Running makemigrations$(RESET)"

@$(COMPOSE) up -d postgresql

@$(MANAGE) makemigrations

.PHONY: makemigrations

migrate: ## run django migrations for the impress project.

@echo "$(BOLD)Running migrations$(RESET)"

@$(COMPOSE) up -d postgresql

@$(MANAGE) migrate

.PHONY: migrate

# Runs the DDL script yhub ships (`bin/init-db.js`, wrapped as `yarn

# init-db`): it creates the yhub database when missing, then every table the

# installed @y/hub version needs. yhub never runs DDL from the server or the

# worker, so this is what applies a schema change after an upgrade.

# Both stores are started because the script also creates the valkey worker

# stream and connects to it whenever REDIS is set. Re-running is safe and

# expected; on an existing stream it logs a harmless `BUSYGROUP` error and

# still exits 0, since the server creates that stream at startup anyway.

migrate-yhub: ## create or upgrade the collaboration server (yhub) schema.

@echo "$(BOLD)Running yhub migrations$(RESET)"

@$(COMPOSE) up -d yhub-postgres yhub-valkey

@$(COMPOSE_RUN) --no-deps yhub yarn init-db

.PHONY: migrate-yhub

superuser: ## Create an admin superuser with password "admin"

@echo "$(BOLD)Creating a Django superuser$(RESET)"

@$(MANAGE) createsuperuser --email [email protected] --password admin

.PHONY: superuser

back-i18n-compile: ## compile the gettext files

@$(MANAGE) compilemessages --ignore=".venv/**/*"

.PHONY: back-i18n-compile

back-i18n-generate: ## create the .pot files used for i18n

@$(MANAGE) makemessages -a --keep-pot --all

.PHONY: back-i18n-generate

shell: ## connect to database shell

@$(MANAGE) shell #_plus

.PHONY: dbshell

# -- Database

dbshell: ## connect to database shell

docker compose exec app-dev python manage.py dbshell

.PHONY: dbshell

resetdb: FLUSH_ARGS ?=

resetdb: ## flush database and create a superuser "admin"

@echo "$(BOLD)Flush database$(RESET)"

@$(MANAGE) flush $(FLUSH_ARGS)

@${MAKE} superuser

.PHONY: resetdb

crowdin-download: ## Download translated message from crowdin

@$(COMPOSE_RUN_CROWDIN) download -c crowdin/config.yml

.PHONY: crowdin-download

crowdin-download-sources: ## Download sources from Crowdin

@$(COMPOSE_RUN_CROWDIN) download sources -c crowdin/config.yml

.PHONY: crowdin-download-sources

crowdin-upload: ## Upload source translations to crowdin

@$(COMPOSE_RUN_CROWDIN) upload sources -c crowdin/config.yml

.PHONY: crowdin-upload

i18n-compile: ## compile all translations

i18n-compile: \

back-i18n-compile \

frontend-i18n-compile

.PHONY: i18n-compile

i18n-generate: ## create the .pot files and extract frontend messages

i18n-generate: \

back-i18n-generate \

frontend-i18n-generate

.PHONY: i18n-generate

i18n-download-and-compile: ## download all translated messages and compile them to be used by all applications

i18n-download-and-compile: \

crowdin-download \

i18n-compile

.PHONY: i18n-download-and-compile

i18n-generate-and-upload: ## generate source translations for all applications and upload them to Crowdin

i18n-generate-and-upload: \

i18n-generate \

crowdin-upload

.PHONY: i18n-generate-and-upload

# -- Mail generator

mails-build: ## Convert mjml files to html and text

@$(MAIL_YARN) build

.PHONY: mails-build

mails-build-html-to-plain-text: ## Convert html files to text

@$(MAIL_YARN) build-html-to-plain-text

.PHONY: mails-build-html-to-plain-text

mails-build-mjml-to-html: ## Convert mjml files to html and text

@$(MAIL_YARN) build-mjml-to-html

.PHONY: mails-build-mjml-to-html

mails-install: ## install the mail generator

@$(MAIL_YARN) install

.PHONY: mails-install

# -- Misc

clean: ## restore repository state as it was freshly cloned

git clean -idx

.PHONY: clean

help:

@echo "$(BOLD)impress Makefile"

@echo "Please use 'make $(BOLD)target$(RESET)' where $(BOLD)target$(RESET) is one of:"

@grep -E '^[a-zA-Z0-9_-]+:.*?## .*$$' $(firstword $(MAKEFILE_LIST)) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "$(GREEN)%-30s$(RESET) %s\n", $$1, $$2}'

.PHONY: help

# Front

frontend-development-install: ## install the frontend locally

cd $(PATH_FRONT_IMPRESS) && yarn

.PHONY: frontend-development-install

frontend-lint: ## run the frontend linter

cd $(PATH_FRONT) && yarn lint

.PHONY: frontend-lint

run-frontend-development: ## Run the frontend in development mode

@$(COMPOSE) stop frontend-development

cd $(PATH_FRONT_IMPRESS) && yarn dev

.PHONY: run-frontend-development

frontend-test: ## Run the frontend tests

cd $(PATH_FRONT_IMPRESS) && yarn test

.PHONY: frontend-test

frontend-i18n-extract: ## Extract the frontend translation inside a json to be used for crowdin

cd $(PATH_FRONT) && yarn i18n:extract

.PHONY: frontend-i18n-extract

frontend-i18n-generate: ## Generate the frontend json files used for crowdin

frontend-i18n-generate: \

crowdin-download-sources \

frontend-i18n-extract

.PHONY: frontend-i18n-generate

frontend-i18n-compile: ## Format the crowin json files used deploy to the apps

cd $(PATH_FRONT) && yarn i18n:deploy

.PHONY: frontend-i18n-compile

# -- K8S

build-k8s-cluster: ## build the kubernetes cluster using kind

./bin/start-kind.sh

.PHONY: build-k8s-cluster

start-tilt: ## start the kubernetes cluster using kind

tilt up -f ./bin/Tiltfile

.PHONY: build-k8s-cluster

bump-packages-version: VERSION_TYPE ?= minor

bump-packages-version: ## bump the version of the project - VERSION_TYPE can be "major", "minor", "patch"

cd ./src/mail && yarn version --no-git-tag-version --$(VERSION_TYPE)

cd ./src/frontend/ && yarn version --no-git-tag-version --$(VERSION_TYPE)

cd ./src/frontend/apps/e2e/ && yarn version --no-git-tag-version --$(VERSION_TYPE)

cd ./src/frontend/apps/impress/ && yarn version --no-git-tag-version --$(VERSION_TYPE)

cd ./src/frontend/servers/y-provider/ && yarn version --no-git-tag-version --$(VERSION_TYPE)

cd ./src/frontend/packages/eslint-plugin-docs/ && yarn version --no-git-tag-version --$(VERSION_TYPE)

cd ./src/frontend/packages/i18n/ && yarn version --no-git-tag-version --$(VERSION_TYPE)

.PHONY: bump-packages-version