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.

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

Add quiet flag to production deployment script #4263

Merged
merged 2 commits into from
Feb 13, 2025
+12 −14
Merged

Add quiet flag to production deployment script #4263

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
639d70e
Add quiet flag for production deployment
Feb 13, 2025
e920e35
Changes suggested by @past
Feb 13, 2025
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
2 changes: 1 addition & 1 deletion Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -300,7 +300,7 @@ cleanup_staging_versions: gcloud_login

deploy_production: deployment_state
gcloud config set project wptdashboard
util/deploy.sh -r $(APP_PATH)
util/deploy.sh -r $(APP_PATH) ${QUIET:+-q}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: I'd reorder and put the flags together, before the app parameter.

rm -rf $(WPTD_PATH)api/query/cache/service/wpt.fyi
rm -rf $(WPTD_PATH)webapp/web/wpt.fyi

Expand Down
22 changes: 10 additions & 12 deletions util/deploy-production.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,27 +7,25 @@
set -e

usage() {
USAGE="Usage: deploy-production.sh [-f] [-b]
USAGE="Usage: deploy-production.sh [-f] [-b] [-q]
-b : skip GitHub issue creation
-f : Always deploy (even if checks have failed)"
-f : Always deploy (even if checks have failed)
-q : Disable all interactive prompts when running gcloud deploy commands"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: the quiet flag removes more things in deploy.sh, so I would rephrase it perhaps as "Disable all interactive prompts and debugging output".

While you are here, do you mind making capitalization more uniform by changing "skip" to "Skip" in the line above?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done!

echo "${USAGE}"
}

# Deletes the service passed as a parameter.
delete_oldest_version() {
OLDEST_REV=$(gcloud app --project=wptdashboard versions list --sort-by=last_deployed_time --filter="service=$1" --limit=1 --format=json | jq -r '.[] | .id')
echo "Deleting $1 service version $OLDEST_REV"
if confirm "Delete $1 service version $OLDEST_REV?"; then
gcloud app versions delete --service=$SERVICE $OLDEST_REV
else
echo "Skipping $1 service version $OLDEST_REV"
fi
gcloud app versions delete --service=$SERVICE $OLDEST_REV ${QUIET:+--quiet}
Copy link
Contributor Author

@DanielRyanSmith DanielRyanSmith Feb 13, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A confirmation here is also removed because it is redundant with the confirmation that exists within the gcloud command, which made it required to confirm with 'y' twice

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: put the flags together before the version parameter?
I agree that 2 confirmations were too many.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done!

}

while getopts ':bfh' flag; do
while getopts ':bfqh' flag; do
case "${flag}" in
b) SKIP_ISSUE_CREATION='true' ;;
f) FORCE_DEPLOY='true' ;;
q) QUIET='true' ;;
h|*) usage && exit 0;;
esac
done
Expand Down Expand Up @@ -116,11 +114,11 @@ ${UTIL_DIR}/docker-dev/run.sh -d
# Login to gcloud if not already logged in.
wptd_exec_it gcloud auth login
# Deploy the services.
wptd_exec_it make deploy_production PROJECT=wptdashboard APP_PATH=webapp/web
wptd_exec_it make deploy_production PROJECT=wptdashboard APP_PATH=results-processor
wptd_exec_it make deploy_production PROJECT=wptdashboard APP_PATH=api/query/cache/service
wptd_exec_it make deploy_production PROJECT=wptdashboard APP_PATH=webapp/web ${QUIET:+QUIET=true}
wptd_exec_it make deploy_production PROJECT=wptdashboard APP_PATH=results-processor ${QUIET:+QUIET=true}
wptd_exec_it make deploy_production PROJECT=wptdashboard APP_PATH=api/query/cache/service ${QUIET:+QUIET=true}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't you need to similarly update the Makefile for this as well?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

deploy.sh actually already has a quiet flag implemented as well 🙂

cd webapp/web
gcloud app deploy --project=wptdashboard index.yaml queue.yaml dispatch.yaml
gcloud app deploy ${QUIET:+--quiet} --project=wptdashboard index.yaml queue.yaml dispatch.yaml
cd ../..

# Stop docker.
Expand Down