Skip to content
This repository has been archived by the owner on Jan 20, 2023. It is now read-only.

Add devfile, CONTRIBUTING.md file, set up image build for dev container. #68

Merged
merged 6 commits into from
Aug 21, 2019

Conversation

AndrienkoAleksandr
Copy link
Contributor

What does this PR do?

Add devfile, CONTRIBUTING.md file, set up image build for dev container.

What issues does this PR fix or reference?

eclipse-che/che#14126

WARNING: DEPENDS ON PR => eclipse-che/che-devfile-registry#79

Signed-off-by: Oleksandr Andriienko oandriie@redhat.com

@codecov
Copy link

codecov bot commented Aug 13, 2019

Codecov Report

Merging #68 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@          Coverage Diff           @@
##           master     #68   +/-   ##
======================================
  Coverage    66.6%   66.6%           
======================================
  Files           6       6           
  Lines         569     569           
======================================
  Hits          379     379           
  Misses        165     165           
  Partials       25      25

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 21952b6...76aa438. Read the comment docs.

CONTRIBUTING.md Outdated
@@ -0,0 +1,93 @@
### Development flow

You can do che-plugin-broker development inside Eclipse CHE workspace.
Copy link
Contributor

Choose a reason for hiding this comment

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

s/CHE/Che/g. It's not an acronym, and you shouldn't be SHOUTING. :)

CONTRIBUTING.md Outdated
To create development Eclipse CHE workspace we provide che-plugin-broker devfile [devfile.yaml](devfile.yaml).
> See more about [devfile](https://redhat-developer.github.io/devfile)

### Create Eclipse CHE workspace from devfile
Copy link
Contributor

@nickboldt nickboldt Aug 13, 2019

Choose a reason for hiding this comment

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

Again, it's Eclipse Che, not CHE! Shh. No yelling. :)

Please fix all refs to CHE. Don't want to confuse people with all the acronym possibilities https://www.abbreviations.com/CHE

Copy link
Contributor

@nickboldt nickboldt left a comment

Choose a reason for hiding this comment

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

Seems reasonable other than the comments about CHE vs. Che.

Though I wish the build process for the two brokers produced a single image, instead of having to have two.

devfile.yaml Outdated Show resolved Hide resolved
Copy link
Contributor

@amisevsk amisevsk left a comment

Choose a reason for hiding this comment

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

Great contribution @AndrienkoAleksandr! This is very useful.

I've built the image and tested the devfile on Che, and everything is working as expected.

I've added a few optional suggestions below (mostly typos, etc.)

devfile.yaml Outdated Show resolved Hide resolved
devfile.yaml Outdated Show resolved Hide resolved
devfile.yaml Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
Signed-off-by: Oleksandr Andriienko <oandriie@redhat.com>
Signed-off-by: Oleksandr Andriienko <oandriie@redhat.com>
Signed-off-by: Oleksandr Andriienko <oandriie@redhat.com>
@AndrienkoAleksandr AndrienkoAleksandr force-pushed the introduceDevfileAndContributingMd branch from 2d6dbea to 518acb2 Compare August 15, 2019 13:29
@AndrienkoAleksandr
Copy link
Contributor Author

I fixed typo, for tasks used make, removed generation test config with list plugins(reused already existed in the source code).

Signed-off-by: Oleksandr Andriienko <oandriie@redhat.com>
Signed-off-by: Oleksandr Andriienko <oandriie@redhat.com>
Signed-off-by: Oleksandr Andriienko <oandriie@redhat.com>
@AndrienkoAleksandr
Copy link
Contributor Author

Though I wish the build process for the two brokers produced a single image, instead of having to have two.

I like your idea and I believe it would make things simpler but I don't think that it can be done really easily in a scope of my issue[1], which goal is to add contribution.md and devfile for developing Plugin Broker in current state.

@amisevsk @sleshchenko WDYT?
@nickboldt Would you mind to create a separate issue to implement such an improvement or do you think it blocks this PR?

[1] eclipse-che/che#14126

@nickboldt
Copy link
Contributor

Would you mind to create a separate issue to implement such an improvement or do you think it blocks this PR?

Done. eclipse-che/che#14296

Does not block this PR.

@AndrienkoAleksandr AndrienkoAleksandr merged commit c3043f4 into master Aug 21, 2019
@AndrienkoAleksandr AndrienkoAleksandr deleted the introduceDevfileAndContributingMd branch August 21, 2019 07:03
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants