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

Add preferences for chePlugin components in Devfile #13341

Merged
merged 1 commit into from
May 24, 2019

Conversation

sleshchenko
Copy link
Member

@sleshchenko sleshchenko commented May 15, 2019

What does this PR do?

This PR adds preferences for chePlugin components in Devfile.
As an example of Devfile where this functionality is used:

Devfile with configured typesctipt plugin
specVersion: 0.0.1
name: cheTheia-in-che
projects:
  - name: devfiles
    source:
      type: git
      location: 'https://github.com/sunix/devfiles.git'
components:
  - 
    alias: theia-editor
    id: eclipse/che-theia/next
    type: cheEditor
  - 
    id: che-incubator/typescript/1.30.2
    type: chePlugin
    memoryLimit: 2048M
    preferences:
       java.jdt.ls.vmargs: '-noverify -Xmx1G -XX:+UseG1GC -XX:+UseStringDeduplication'
       java.home: '/home/user/jdk11'
commands:
  - name: 'say Hello'
    actions:
      - type: exec
        component: che-dev
        command: >
                echo "Hello!"

The same feature can be used with workspace config, plugin.{PLUGIN_PUBLISHER}/{PLUGIN_NAME}.preference.{PREFERENCE_NAME} workspace config attribute is used.

Workspace config with configured plugin
{
    "projects": [
        {
            "source": {
                "location": "https://github.com/sunix/devfiles.git",
                "type": "git",
                "parameters": {}
            },
            "name": "devfiles",
            "path": "/devfiles"
        }
    ],
    "defaultEnv": "default",
    "name": "cheTheia-in-che",
    "attributes": {
        "editor": "eclipse/che-theia/next",
        "editorComponentAlias": "theia-editor",
        "plugin.che-incubator/typescript.preference.java.jdt.ls.vmargs": "-noverify -Xmx1G -XX:+UseG1GC -XX:+UseStringDeduplication",
        "plugins": "eclipse/che-machine-exec-plugin/0.0.1,che-incubator/typescript/1.30.2",
        "sidecar.che-incubator/typescript.memory_limit": "2048M",
        "plugin.che-incubator/typescript.preference.java.home": "/home/user/jdk11"
    }
}

There is a docker image sleshchenko/che-server:plugin-prefs that contains PR's changes. It may be used for testing.

What issues does this PR fix or reference?

#12992

Release Notes

Added an ability to specify preferences for plugins in Devfile and Workspace Config.

Docs PR

Docs changes are included in the PR

@sleshchenko sleshchenko force-pushed the ext-prefs-in-devfile branch 3 times, most recently from 972aecf to d01d628 Compare May 17, 2019 10:53
@sleshchenko sleshchenko marked this pull request as ready for review May 17, 2019 10:53
@sleshchenko sleshchenko self-assigned this May 17, 2019
@sleshchenko sleshchenko added status/code-review This issue has a pull request posted for it and is awaiting code review completion by the community. kind/enhancement A feature request - must adhere to the feature request template. labels May 17, 2019
@sleshchenko
Copy link
Member Author

ci-test

@che-bot
Copy link
Contributor

che-bot commented May 17, 2019

Results of automated E2E tests of Eclipse Che Multiuser on OCP:
Build details
Test report
docker image: eclipseche/che-server:13341
https://github.com/orgs/eclipse/teams/eclipse-che-qa please check this report.

@sleshchenko
Copy link
Member Author

ci-test

@che-bot
Copy link
Contributor

che-bot commented May 17, 2019

Results of automated E2E tests of Eclipse Che Multiuser on OCP:
Build details
Test report
docker image: eclipseche/che-server:13341
https://github.com/orgs/eclipse/teams/eclipse-che-qa please check this report.

@dmytro-ndp
Copy link
Contributor

ci-test

@che-bot
Copy link
Contributor

che-bot commented May 17, 2019

Results of automated E2E tests of Eclipse Che Multiuser on OCP:
Build details
Test report
docker image: eclipseche/che-server:13341
https://github.com/orgs/eclipse/teams/eclipse-che-qa please check this report.

Copy link
Contributor

@metlos metlos left a comment

Choose a reason for hiding this comment

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

Some minor comments but otherwise good!

@SkorikSergey
Copy link
Contributor

Selenium tests execution on Eclipse Che Multiuser on OCP (https://ci.codenvycorp.com/job/che-pullrequests-test-ocp/1801//Selenium_20tests_20report/) doesn't show any regression against this Pull Request.

Signed-off-by: Sergii Leshchenko <sleshche@redhat.com>
@sleshchenko
Copy link
Member Author

Rebased onto master branch without any changes in PR

@sleshchenko
Copy link
Member Author

ci-build

@sleshchenko sleshchenko merged commit c94c3ac into master May 24, 2019
@sleshchenko sleshchenko deleted the ext-prefs-in-devfile branch May 24, 2019 05:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/enhancement A feature request - must adhere to the feature request template. status/code-review This issue has a pull request posted for it and is awaiting code review completion by the community.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants