Use GOV.UK Docker to test GOV.UK Docker #608
Merged
Conversation
This file contains 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
This matches the current behaviour of CI [^1]. Making this change will help simplify the way we run tests locally. I've split out the non-Ruby test commands into a new "test-scripts" recipe as part of this - so that we can reuse it elsewhere. Normally we would do linting as part of the default "make" task, but that's not appropriate here as we also run make commands to set up individual projects; having the default "make" run tests would be confusing for someone who's just trying to use GOV.UK Docker. I think it's reasonable to include linting as part of the "test" recipe, as we generally want to run both if we're changing Ruby code. [^1]: https://github.com/alphagov/govuk-docker/blob/main/.github/workflows/ci.yml
added 2 commits
June 20, 2022 13:28
This is a bit meta but much easier than forcing someone to create their own Ruby environment for this purpose. This leaves bin/doctor as the only part of the repo that requires a local Ruby environment, so I've moved the installation guidance to the relevant part of the troubleshoot manual. Since some of the testing commands assume local file paths or run Docker itself, we can't run all the "tests" inside a container, so I've added separate recipes / commands to run the tests on CI and locally. I'm not worried about them diverging.
Neither of these were necessary for normal use of GOV.UK Docker, and the previous commits also make them redundant for running the tests.
kevindew
approved these changes
Jun 27, 2022
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.
Fixes #589.
This adds a new stack so that GOV.UK Docker has its own Ruby
environment to run Ruby commands in.
As part of doing this, I've also tweaked the guidance so that
all the relevant setup instructions are inline with the one use
case that remains for a local Ruby environment - bin/doctor -
which should itself be removed in time 1.
Please see the commits for more details.
Footnotes
https://github.com/alphagov/govuk-docker/issues/435 ↩