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

fix(docker-compose): omit version if schemaVersion is not provided #3562

Merged
merged 8 commits into from
May 10, 2024

Conversation

Tucker-Eric
Copy link
Contributor

@Tucker-Eric Tucker-Eric commented May 7, 2024

The version element is deprecated in docker compose configs (https://github.com/compose-spec/compose-spec/blob/master/spec.md#version-and-name-top-level-elements)

This change omits version from the docker-compose.yml when schemaVersion isn't set. Not removing it completely to allow for backwards compatibility.


By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@codecov-commenter
Copy link

codecov-commenter commented May 7, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.35%. Comparing base (ad20d2c) to head (925bdfc).
Report is 38 commits behind head on main.

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@           Coverage Diff            @@
##             main    #3562    +/-   ##
========================================
  Coverage   96.34%   96.35%            
========================================
  Files         192      192            
  Lines       37696    37738    +42     
  Branches     3524     2643   -881     
========================================
+ Hits        36320    36364    +44     
+ Misses       1376     1374     -2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

@mrgrain mrgrain left a comment

Choose a reason for hiding this comment

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

Good catch! Can you also @deprecated the options please

@Tucker-Eric
Copy link
Contributor Author

Good catch! Can you also @deprecated the options please

Done!

@mrgrain
Copy link
Contributor

mrgrain commented May 9, 2024

src/docker-compose/docker-compose.ts:43:3 - error JSII7999: @deprecated tag needs a reason and/or suggested alternatives.

and then you'll have to update the generated API docs again

@Tucker-Eric
Copy link
Contributor Author

src/docker-compose/docker-compose.ts:43:3 - error JSII7999: @deprecated tag needs a reason and/or suggested alternatives.

and then you'll have to update the generated API docs again

All updated!

@mrgrain mrgrain changed the title feat(docker-compose): omit version if schemaVersion is not provided fix(docker-compose): omit version if schemaVersion is not provided May 10, 2024
@mergify mergify bot merged commit cbbfb4e into projen:main May 10, 2024
15 of 16 checks passed
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.

None yet

3 participants