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

Created Docker Compose Component #1134

Closed
wants to merge 6 commits into from

Conversation

Mahajanet
Copy link

What does this PR do?

There is now a docker-compose reference in Devfile which allows to provide an existing docker-compose file for the application definition. Created the component, wrote for validation and testing.

Link to Issue

#1120

PR acceptance criteria

Testing and documentation do not need to be complete in order for this PR to be approved. We just need to ensure tracking issues are opened.

  • Open new test/doc issues under the devfile/api repo
  • Check each criteria if:
  • There is a separate tracking issue. Add the issue link under the criteria
    or
  • test/doc updates are made as part of this PR
  • If unchecked, explain why it's not needed
  • A new component in devfile API for docker-compose file reference [completed]
  • validation need to be done for the new component [completed]
  • new tests for testing the new component [completed]

How to test changes / Special notes to the reviewer

@openshift-ci
Copy link

openshift-ci bot commented Jun 13, 2023

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: Mahajanet

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@yangcao77 yangcao77 marked this pull request as draft June 13, 2023 13:57
@@ -0,0 +1,3 @@
name: docker-compose
dockerfile:
Copy link
Member

Choose a reason for hiding this comment

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

shouldn't this be compose?

Comment on lines +10 to +23
type ComposeFileComponentLocation struct {

// Type of Compose file Component Location

LocationType ComposeFileComponentLocationType `json:"locationType,omitempty"`

// Location uri of the docker-compose file

Uri string `json:"uri,omitempty"`

// Inline docker-file

Inlined string `json:"inlined,omitempty"`
}
Copy link
Contributor

Choose a reason for hiding this comment

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

Please remove blank lines below documentation comments:

Suggested change
type ComposeFileComponentLocation struct {
// Type of Compose file Component Location
LocationType ComposeFileComponentLocationType `json:"locationType,omitempty"`
// Location uri of the docker-compose file
Uri string `json:"uri,omitempty"`
// Inline docker-file
Inlined string `json:"inlined,omitempty"`
}
type ComposeFileComponentLocation struct {
// Type of Compose file Component Location
LocationType ComposeFileComponentLocationType `json:"locationType,omitempty"`
// Location uri of the docker-compose file
Uri string `json:"uri,omitempty"`
// Inline docker-file
Inlined string `json:"inlined,omitempty"`
}

(see https://tip.golang.org/doc/comment)

@github-actions
Copy link

This PR is stale because it has been open for 90 days with no activity. Remove stale label or comment or this will be closed in 60 days.

@github-actions github-actions bot added the lifecycle/stale Stale items. These items have not been updated for 90 days. label Sep 18, 2023
@maysunfaisal
Copy link
Member

@yangcao77 this PR has also been tagged as stale. Do we want to get someone to take a look at it?

@yangcao77
Copy link
Contributor

@maysunfaisal this PR was opened just for POC, and is not ready for review, all tests are missing.
We can close off this PR, but it is a good starting point for the next person going to take the ownership of the issue.

@yangcao77 yangcao77 closed this Sep 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
do-not-merge/work-in-progress lifecycle/stale Stale items. These items have not been updated for 90 days.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants