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.

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

feat: implement feature to fail builds on docker-compose yaml errors #340

Merged
merged 2 commits into from
Oct 30, 2024

Conversation

shreddedbacon
Copy link
Member

@shreddedbacon shreddedbacon commented Jul 26, 2024

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 flags

# per project/environment
LAGOON_FEATURE_FLAG_DEVELOPMENT_DOCKER_COMPOSE_VALIDATION=disabled

# per cluster in the remote-controller
LAGOON_FEATURE_FLAG_DEFAULT_DEVELOPMENT_DOCKER_COMPOSE_VALIDATION=disabled

Production environments will continue to warn, but it is possible to enable the errors using feature flags

# per project/environment
LAGOON_FEATURE_FLAG_PRODUCTION_DOCKER_COMPOSE_VALIDATION=enabled

# per cluster in the remote-controller
LAGOON_FEATURE_FLAG_DEFAULT_PRODUCTION_DOCKER_COMPOSE_VALIDATION=enabled

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.

@shreddedbacon shreddedbacon changed the title feat: implement feature to start failing builds on docker-compose yaml errors feat: implement feature to fail builds on docker-compose yaml errors Jul 26, 2024
@shreddedbacon shreddedbacon force-pushed the fail-docker-compose-yaml-errors branch from 4a9296e to 707a8e8 Compare July 26, 2024 05:25
@shreddedbacon shreddedbacon force-pushed the fail-docker-compose-yaml-errors branch 2 times, most recently from fa0bc42 to 4d3538e Compare August 20, 2024 06:09
@shreddedbacon shreddedbacon added this to the 2.22.0 milestone Aug 21, 2024
@shreddedbacon shreddedbacon force-pushed the fail-docker-compose-yaml-errors branch from 4d3538e to 103d8c7 Compare August 21, 2024 00:27
@shreddedbacon shreddedbacon force-pushed the fail-docker-compose-yaml-errors branch from 5818195 to 991a257 Compare October 3, 2024 00:57
@shreddedbacon shreddedbacon marked this pull request as ready for review October 14, 2024 21:08
@shreddedbacon shreddedbacon force-pushed the fail-docker-compose-yaml-errors branch 2 times, most recently from a8c01b5 to 9e0bbce Compare October 21, 2024 22:34
@shreddedbacon shreddedbacon force-pushed the fail-docker-compose-yaml-errors branch 2 times, most recently from a00c774 to 6b83f93 Compare October 28, 2024 01:35
Copy link
Member

@tobybellwood tobybellwood left a comment

Choose a reason for hiding this comment

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

This works, and makes sense to implement with itssafeguards

@shreddedbacon shreddedbacon merged commit 4e37875 into main Oct 30, 2024
2 checks passed
@shreddedbacon shreddedbacon deleted the fail-docker-compose-yaml-errors branch October 30, 2024 07:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants