fix: Revise e2e-test-review + e2e-test-staging step names#1200
Merged
Conversation
Member
apaleslimghost
left a comment
There was a problem hiding this comment.
looks good!
chore: to be releaseable, this commit would have to be a fix: or a feat:. i think fix: is closest.
f6f0ad5 to
2ad8b61
Compare
Contributor
Author
|
Fab — I've amended the commit name to |
apaleslimghost
approved these changes
Mar 17, 2026
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
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
The
tool-kit/e2e-test-reviewandtool-kit/e2e-test-stagingjobs include a step that is intended to run the end-to-end tests.However, the name of that step its:
tool-kit/e2e-test-reviewjob)tool-kit/e2e-test-stagingjob)The explanation for this is given by @apaleslimghost in this Slack post from Wed 07 Jan 2026 at 10:50:
However, in those instances where we do run end-to-end tests in the
tool-kit/e2e-test-reviewandtool-kit/e2e-test-stagingjobs, they appear in a step whose name misleadingly suggests that smoke tests are being run, e.g. https://app.circleci.com/pipelines/github/Financial-Times/next-appetite/25318/workflows/47493522-5069-4669-a459-0a522303d5cf/jobs/52244 (the "Smoke tests" step actually runs Cypress end-to-end tests).The ideal would be to be able to provide a custom name for the step. However, as that would likely entail additional work, the next best solution would seem to be to rename the step at source to something that corresponds more closely with the job name (which is presumably considered to be a bit more abstract in that it is intended to run a mixture of both end-to-end and smoke tests).
That change of the step name is proposed by this PR.
Additional notes
@apaleslimghost talked @ytcleon through the options for adding custom post-steps to an existing job (see below yml snippet). The obstacle we would face here would be that adding end-to-end tests in a post-step at the end of the
tool-kit/e2e-test-reviewortool-kit/e2e-test-stagingjob would be that it comes after the "Uploading artifacts" step.We would require end-to-end tests to occur prior to the "Uploading artifacts" step as they typically produce artifacts.
However, the smoke tests provide by
n-testdo not produce artifacts, and so they could be added in a post-step for which we could provide a custom name when defining it.The final wrinkle would then be the apps in our estate which have smoke tests but no end-to-end tests (e.g. next-barrier-page, user-onboarding) where we'd want to have a post-step for smoke tests but nothing running in the spot of end-to-end tests, but that's something we can worry about later.
Checklist:
feat(circleci): add support for nightly workflows,fix: set Heroku app name for staging apps too