Skip to content

build(deploy): refresh OpenAPI docs after deployments #1540

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.

Sign up for GitHub

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

Merged
NishaSharma14 merged 5 commits into from
Sep 7, 2026
Merged

build(deploy): refresh OpenAPI docs after deployments #1540

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
35240dc
build(deploy): refresh OpenAPI docs after deployments
NishaSharma14 Sep 2, 2026
aca4426
Merge branch 'development' into issue-#1539
NishaSharma14 Sep 2, 2026
64eced8
Add check for OpenAPI documentation refresh status
vcnainala Sep 7, 2026
a378d0f
Update log message for deployment script
vcnainala Sep 7, 2026
6aab9d8
Add check to skip OpenAPI docs refresh if already done
NishaSharma14 Sep 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 18 additions & 2 deletions deployment/deploy-dev.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -192,15 +192,31 @@ backup_database() {
fi
}

refresh_openapi_docs() {
: "${OPENAPI_DOCS_REFRESHED:=false}"
if [[ "$OPENAPI_DOCS_REFRESHED" == "true" ]]; then
log_message "OpenAPI documentation already refreshed; skipping"
return 0
fi

log_message "Refreshing OpenAPI documentation..."

docker compose -f "$COMPOSE_FILE" exec -T app sh -lc 'cd /var/www/html && L5_SWAGGER_USE_REFLECTION_ANALYSER=true php artisan l5-swagger:generate && cp storage/api-docs/api-docs.json public/api-docs.json'

OPENAPI_DOCS_REFRESHED=true
log_message "OpenAPI documentation refreshed successfully"
}
Comment thread
Copilot marked this conversation as resolved.

run_migration_and_clear_cache() {
log_message "Running database migration..."
log_message "Running database migration, refreshing OpenAPI docs, and clearing cache..."

docker compose -f "$COMPOSE_FILE" exec -T app php artisan migrate --force
docker compose -f "$COMPOSE_FILE" exec -T app php artisan cache:clear
docker compose -f "$COMPOSE_FILE" exec -T app php artisan optimize:clear
refresh_openapi_docs
docker compose -f "$COMPOSE_FILE" exec -T app php artisan optimize

log_message "Database migration completed successfully"
log_message "Database migration and cache refresh completed successfully"
}

build_multi_platform() {
Expand Down
20 changes: 18 additions & 2 deletions deployment/deploy-prod.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -276,14 +276,30 @@ backup_and_upload_to_ceph() {
fi
}

refresh_openapi_docs() {
: "${OPENAPI_DOCS_REFRESHED:=false}"
if [[ "$OPENAPI_DOCS_REFRESHED" == "true" ]]; then
log_message "OpenAPI documentation already refreshed; skipping"
return 0
fi

log_message "Refreshing OpenAPI documentation..."

docker compose -f "$COMPOSE_FILE" exec -T app sh -lc 'cd /var/www/html && L5_SWAGGER_USE_REFLECTION_ANALYSER=true php artisan l5-swagger:generate && cp storage/api-docs/api-docs.json public/api-docs.json'

OPENAPI_DOCS_REFRESHED=true
log_message "OpenAPI documentation refreshed successfully"
}
Comment thread
Copilot marked this conversation as resolved.

run_migration_and_clear_cache() {
log_message "Running database migration and clearing cache..."
log_message "Running database migration, refreshing OpenAPI docs, and clearing cache..."

docker compose -f "$COMPOSE_FILE" exec -T app php artisan migrate --force
docker compose -f "$COMPOSE_FILE" exec -T app php artisan optimize
refresh_openapi_docs
docker compose -f "$COMPOSE_FILE" exec -T app php artisan optimize:clear

log_message "Database migration completed successfully"
log_message "Database migration, OpenAPI documentation refresh, and cache clear completed successfully"
}

build_multi_platform() {
Expand Down
Loading