fix: make review app URLs predictable #806
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ivomurrell
reviewed
Mar 7, 2025
rowanmanning
force-pushed
the
predictable-review-apps
branch
2 times, most recently
from
0fa2947 to
d0af161
Compare
We now generate a hash based on the branch name and use this as a suffix
on review app names. This means a couple of things:
1. Review app names are predictable
2. Only one review app will be created per branch, with future commits
to that branch updating the existing review app instead of
deploying another one
This is good for a couple of reasons:
We can now hand the review app URL off to future jobs. This is important
for the n-test and cyprus plugins which expect a URL in the `review` or
`staging` state.
We will stop creating a new review app for every commit, we're already
seeing way too many review apps get created which is a problem while we
don't have automatic deletion of old review apps.
Changes to a PR will deploy faster because most of the review app
CloudFormation stack will have been created already - we'll be doing
updates instead of fully creating a new stack on each commit.
See-also: https://financialtimes.atlassian.net/browse/CPREL-1300
rowanmanning
force-pushed
the
predictable-review-apps
branch
from
d0af161 to
8aa5b22
Compare
ivomurrell
approved these changes
Mar 13, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
We now generate a hash based on the branch name and use this as a suffix on review app names. This means a couple of things:
This is good for a couple of reasons:
We can now hand the review app URL off to future jobs. This is important for the n-test and cyprus plugins which expect a URL in the
revieworstagingstate.We will stop creating a new review app for every commit, we're already seeing way too many review apps get created which is a problem while we don't have automatic deletion of old review apps.
Changes to a PR will deploy faster because most of the review app CloudFormation stack will have been created already - we'll be doing updates instead of fully creating a new stack on each commit.
Here's an example of a review app deployed with this change. The suffix
f81bbdisexample-branchhashed. I tried running the deploy a second time and the stack was updated instead of created, super quick.See-also: CPREL-1300
Checklist:
feat(circleci): add support for nightly workflows,fix: set Heroku app name for staging apps too