feat: implement feature to fail builds on docker-compose yaml errors #340
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.
To help make #304 a reality, this is a phased approach to implement the failure that is detected if a docker-compose file has yaml errors that need to be addressed.
By default, this will make
development
type environments builds fail. It is possible to disable this error using the feature flagsProduction environments will continue to warn, but it is possible to enable the errors using feature flags
Eventually though, the warnings will become failures with no way to disable the error as we upgrade the library.
We will announce before this takes place though.
As warnings have been available in builds for over 6 months now, and these errors are thrown if you're using a new version of docker compose locally, most users will likely have addressed these problems if they had them.
Information about how to temporarily disable the error are presented in the output of the error so that users are able to resolve.
This has been flagged for 2.22.0 so that at least for amazeeio there will be time for communication to be provided. The release notes of 2.21.0 should mention this change as coming in 2.22.0 for open source users to be aware of.