Kubernetes based Cloud Development Environments for Enterprise Teams

RAW Doc

CHANGELOG

Change Log

7.4.0 (2019-11-07)


Full Changelog

Merged pull requests:

- Increate test timeouts for ServersCheckerTest \#15032 (sleshchenko)
- RELEASE: Set next development version \#15141 (vparfonov)
- Improve docs and devfile on workspace loader development flow \#15125 (mmorhun)
- Fix UD build \#15112 (akurinnoy)
- Fixing Vert.x test \#15083 (Katka92)
- Fix TypeScript DTO generator \#15078 (evidolob)
- \[Selenium\] Adapt selenium tests from ocpoauth package \#15058 (SkorikSergey)
- Fixed MeteredExecutorServiceWrapperTest that is failing some Linux system \#15034 (skabashnyuk)
- Fix branding for UD \#14984 (akurinnoy)
- \[Selenium\] Adapt selenium tests from dashboard package \#14980 (SkorikSergey)
- Do not use spy in ServerCheckerTest \#14975 (skabashnyuk)
- RELEASE: Update CHANGELOG \#14972 (vparfonov)
- Don't override entrypoint for remote binary. \#14969 (AndrienkoAleksandr)
- Fix bug where broker container name can exceed 63 characters \#14964 (amisevsk)
- Remove deprecated docker infrastructure \#14951 (skabashnyuk)
- Mount each private key into single kubernetes secret \#14950 (vzhukovskii)
- Remove outaded agent auth filter and unused models; \#14940 (mshaposhnik)
- Add support endpoints for VSCode extensions and Theia plugins. \#14937 (AndrienkoAleksandr)
- Change version of maven artifacts after updating the happy-path project \#14936 (musienko-maxim)
- Stabilize DirectUrlFactoryWithSpecificBranchTest \#14929 (musienko-maxim)
- Fix typo in plugin broker error messages \#14928 (amisevsk)
- Fix of Vert.x E2E test \(\#14924\) \#14925 (dmytro-ndp)
- Upgrade metrics and tracing dependencies \#14923 (skabashnyuk)
- Use newer version of Jgroups and EclipseLink to prevent PKIX errors on OCP 4.x \#14920 (mshaposhnik)
- Remove old dependencies \#14919 (vparfonov)
- Disable autosave on Devfile editor page \#14913 (akurinnoy)
- Use che.infrastructure.kubernetes.namespace.default during workspace namespace resolution \#14828 (metlos)
- Monitoring & Tracing capability for multiple Thread pools of Che Server \#14727 (skabashnyuk)

7.3.1 (2019-10-29)


Full Changelog

Merged pull requests:

- Get rid of non-working workaround to flakiness when Java LS server initialization failed \#14945 (dmytro-ndp)
- Disable cors on master. Cleanup cors configuration on ws-agent \#14921 (skabashnyuk)
- Preview url on server \#14713 (sparkoo)


7.3.0 (2019-10-18)


Full Changelog

Merged pull requests:

- Remove old dependencies \#14919 (vparfonov)
- check devfile apiVersion against all supported versions \#14869 (sparkoo)
- Add sparseCheckoutDir parameter into devfile spec \#14823 (mmorhun)
- Added missing setnev.sh after moving from che-lib \#14818 (skabashnyuk)
- Generate a new SSH key if no keys are registered while ssh mount \#14767 (vinokurig)
- RELEASE: Set next development version \#14690 (vparfonov)
- Migrate code from che-lib \#14592 (skabashnyuk)
- RELEASE: Set next development version \#14904 (vparfonov)
- Extend the size of the pool that is handling workspace related operations \#14884 (skabashnyuk)
- Remove namespace in command prefix in Happy path tests \#14875 (dmytro-ndp)
- Selenium: Enable java selenium E2E test to test suite \#14870 (artaleks9)
- Selenium: Disable java selenium e2e test from test suite \#14841 (artaleks9)
- Fix load-factory redirection in case of policies.create='peruser' \#14836 (olexii4)
- load devfile schema for validation by it's apiVersion \#14834 (sparkoo)
- Use newer che-plugin-broker with che-theia remote runtime injection \#14832 (AndrienkoAleksandr)
- Validation of devfiles on workspace update \#14826 (mshaposhnik)
- Add workaround for handling unexpected pop ups during redirection maven build to editor \#14814 (musienko-maxim)
- Revert "Devfile validation via message entity provider" \#14812 (mshaposhnik)
- E2E: Modify e2e test 'InstallCheByOperatorHub' to use with both Che and Crw \#14798 (artaleks9)
- Serialize/deseialize list of DTO using same mechanism as single DTO object \#14792 (mshaposhnik)
- Set 600 file permissions to mounted SSH keys \#14791 (vinokurig)
- \[TS\_SELENIUM\] Create image for the "Happy Path" tests based on the "quay.io/eclipse/che-java11-maven" image \#14779 (Ohrimenko1988)
- \[Selenium\] Adapt selenium test from hotupdate.recreate package \#14777 (SkorikSergey)
- Increase test workspace editor memory; grab Happy path tests logs and configs \#14774 (dmytro-ndp)
- \[regression\] Fix provisioning volume for ephemeral-mode workspaces. \#14768 (amisevsk)
- \[Selenium\] Adapt selenium tests from hotupdate.rolling package \#14765 (SkorikSergey)
- chore\(github\): Fix template label for bugs \#14757 (benoitf)
- Changed default idle timeout and limit of running workspaces per user \#14747 (skabashnyuk)
- Selenium: Enable selenium java tests related to Github OAuth authorization \#14744 (artaleks9)
- Devfile validation via message entity provider \#14740 (mshaposhnik)
- \[TS\_SELENIUM\] Add VNC server to the "eclipse/che-e2e" docker image \#14730 (Ohrimenko1988)
- prevent workspace restarting if user intentionally stopped it \#14728 (akurinnoy)
- Selenium: Disable selenium tests related to GitHub OAuth \#14719 (artaleks9)
- \[Selenium\] Adapt selenium tests from workspaces package \#14716 (SkorikSergey)
- Fix editor components alias attribute format to match plugins attribute format \#14715 (mshaposhnik)
- Show the warning message in the case with deprecated plugins \#14707 (olexii4)
- RELEASE: Update CHANGELOG \#14701 (vparfonov)
- Update Deployments yamls in helm charts to be compatible with k8s v1.16 \#14700 (l0rd)
- Reduce the chances that successfulCheckTest will fail \#14688 (skabashnyuk)
- Change grafana configuration to match hosted che configuration \#14684 (tomgeorge)
- Set Y axis unit to none \#14682 (tomgeorge)
- Change 'Docker Registries' to 'Container Registries' \#14675 (tomgeorge)
- Add an ability to list available k8s namespaces \#14541 (sleshchenko)
- refactor: remove unused code \#14480 (vitaliy-guliy)


7.2.0 (2019-09-27)


Full Changelog

Merged pull requests:

- Fix security vulnerability and Dashboard's workspace detail page \#14644 (akurinnoy)
- Change grafana dashboards for number of workspaces/users to be graphs with axes \#14588 (tomgeorge)
- Remove installer registry service \#14193 (mkuznyetsov)
- RELEASE: Set next development version \#14690 (vparfonov)
- \[TS\_SELENIUM\] Increase logging of tests steps \#14686 (Ohrimenko1988)
- \[TS\_SELENIUM\] Implement workaround for issue \#14660 \(Unexpected list of suggestions when use Java languageserver\) in the "HappyPath" test. \#14672 (Ohrimenko1988)
- Fix a UD-branding link \#14643 (olexii4)
- \[TS\_SELENIUM\] Increase logging of tests steps \#14642 (Ohrimenko1988)
- Minor fixes to new Che workspace Grafana panels \#14626 (mkuznyetsov)
- \[Selenium\] Adapt selenium tests from ocpoauth package \#14619 (SkorikSergey)
- Add component alias into runtime machine if present in origin devfile \#14610 (mshaposhnik)
- \[Selenium\] Adapt selenium tests to work with workspaces from Che7 stacks \#14594 (SkorikSergey)
- Add new Tomcat metrics dashboard in Grafana \#14578 (mkuznyetsov)
- Makes sure the workspace activity checker reconciles the workspaces with their true statuses. \#14574 (metlos)
- replace sed delimiters to be able to use / in docker image buildscript \#14572 (sparkoo)
- \[Selenium\] Fix unstable selenium tests from dashboard package \#14571 (SkorikSergey)
- Implement workaround for Go to Definition feature HappyPath scenario \#14570 (musienko-maxim)
- Cleanup of temporary workspaces by schreduler instead of startup \#14561 (mshaposhnik)
- Add Ssh Api methods to list of allowed requests signed with machine token \#14557 (vinokurig)
- Plugin ephemeral volume feature for CheContainers \#14539 (AndrienkoAleksandr)
- chore \(CONTRIBUTING.md\): update list of repos/components with links t… \#14537 (sunix)
- Provide an ability to create workspaces from factories per user \#14535 (olexii4)
- Add workspaces started under 60 seconds ratio panel \#14533 (mkuznyetsov)
- Remove WsAgent specific classes from che-core-workspace-api \#14528 (sleshchenko)
- workspace namespace/project placeholders \#14524 (sparkoo)
- Adapt test after updating Monaco editor \#14523 (musienko-maxim)
- Refresh keycloak token \#14521 (akurinnoy)
- Fail build if checksum of the downloaded artifact is not matched \#14518 (skabashnyuk)
- Fix the editors list for UD \#14515 (olexii4)
- Provision name and email from user profile if preferences are empty \#14508 (vzhukovskii)
- \[E2E\] Parametrize docker to set test suite \#14507 (Katka92)
- chore\(README\): fix link to other repositories \#14501 (sunix)
- Add step for selecting output parser into test \#14493 (musienko-maxim)
- Add missing registration for git preferences provisioner \#14488 (vzhukovskii)
- Add ability override container root command. \#14453 (AndrienkoAleksandr)
- Do not apply proxy settings for JWTProxy container; \#14448 (mshaposhnik)
- Reconfigure Gson to parse more complex theia preference object \#14442 (vzhukovskii)
- RELEASE: Update CHANGELOG for 7.1.0 \#14441 (ibuziuk)
- \[E2E\] Fixing bug in opening file. \#14435 (Katka92)
- RELEASE: Set next '7.2.0-SNAPSHOT' development version \#14430 (ibuziuk)
- \[Happy Path\] Resolve problem with debug step of the "Happy-Path" scenario \#14420 (Ohrimenko1988)
- Add Host Key checking policy attribute to the ssh config \#14418 (vinokurig)
- Correct Che image tag in Helm Chart values file \#14396 (SamCHogg)
- Fix PR check Jenkinsfile to use 'che-e2e' image \#14387 (dmytro-ndp)
- Remove outdated Che6 concept. Devfile should be used instead \#14383 (skabashnyuk)
- Support single-host mode on the multi-user server \#14335 (metlos)
- Fix potential security vulnerabilities \#14313 (akurinnoy)
- Fix devfile component preferences deserialization through GSON \#14306 (mkuznyetsov)
- \[Happy-Path\] Update chromedriver to version 76.0.0 \#14144 (Ohrimenko1988)

6.19.6 (2019-09-19)


Full Changelog

Merged pull requests:

- \[E2E\] Add test for Java Vertx workspace. \#14558 (Katka92)
- Add Grafana panels with workspace traces metrics \#14500 (mkuznyetsov)


7.1.0 (2019-09-05)


Full Changelog

Merged pull requests:

- \[E2E\] Fixing bug in opening file. \#14435 (Katka92)
- RELEASE: Set next '7.2.0-SNAPSHOT' development version \#14430 (ibuziuk)
- Update default plugin brokers to v0.20 - support relative paths \#14329 (amisevsk)
- Fix handling of error status of a workspace \#13804 (akurinnoy)
- \[e2e\] Added multiuser support. \#14417 (rhopp)
- Fix PR check Jenkinsfile \#14410 (dmytro-ndp)
- Provision git configuration into each container \#14402 (vzhukovskii)
- Add init containers in the che plugin model \#14397 (AndrienkoAleksandr)
- Update screencatcher in the e2e folder for avoiding errors \#14394 (Ohrimenko1988)
- \[Happy Path\] Fix checking application readiness in HappyPath test \#14381 (SkorikSergey)
- Fix converting URL for UD \#14377 (olexii4)
- Update existed "che-e2e" image for using on CI \#14351 (Ohrimenko1988)
- Add small fixes for UD \#14347 (olexii4)
- Don't blow up on missing path transform configuration \#14339 (metlos)
- \[Selenium\] Fix Java selenium tests to run against Che with next version for default plugins \#14337 (SkorikSergey)
- Exclude failing java selenium tests from default execution \#14327 (dmytro-ndp)
- \[Selenium\] Delete Che7PreviewStackStartTest selenium test \#14323 (SkorikSergey)
- Avoid using DtoImpls directly \#14320 (sleshchenko)
- factory will always use devfile generateName \#14311 (sparkoo)
- Fix ability to scroll for UD \#14307 (olexii4)
- \[e2e\] - Add source maps. Fixes \#14298 \#14299 (rhopp)
- Fix a build errors for UD \#14293 (olexii4)
- Add trailing 0 to Happy path tests screencast png's \#14292 (dmytro-ndp)
- use the latest nightly image \#14285 (vparfonov)
- \[HappyPath\] Make checking running application more stable \#14284 (SkorikSergey)
- \[E2E\] Adding script for generating index.ts file. \#14281 (Katka92)
- Set che-plugin-registry image version to 7.0.0 \#14278 (vparfonov)
- Add the jwt-proxy memory as a part of stack's globalMemoryLimit \#14270 (olexii4)
- Update default plugin/devfile registries to use prod-preview \#14267 (amisevsk)
- Set all image version to the 7.0.0 to align it with CheTheia version \#14264 (vparfonov)
- set plugin registry image to nightly \#14259 (vparfonov)
- Revert "Use next version for default plugins" \#14249 (vparfonov)
- Use next version for default plugins \#14247 (vparfonov)
- \[E2E\] Stop and remove workspace on failed test \#14246 (Katka92)
- watch PVC WaitForFirstConsumer event to avoid deadlock \#14239 (sparkoo)
- RELEASE: Set next development version \#14238 (vparfonov)
- Add workspace-loader flow \#14222 (olexii4)
- Simplify build of che artifacts by PR check pipeline job \#14214 (dmytro-ndp)
- Add possibility to build images from "dockerfiles" folder with '--no-cache' option \#14213 (Ohrimenko1988)
- Make code & test independent from environment and time of execution \#14207 (skabashnyuk)
- Add docs how to build Che server in Che workspace \#14181 (mmorhun)
- Allow chePlugin preferences to be string, int or boolean type \#14174 (mshaposhnik)
- add generateName to devfile metadata \#14157 (sparkoo)
- Generalize the ingress configuration to support single-host in single-user mode on kubernetes \#14134 (metlos)
- Remove Project Template API \#14109 (mkuznyetsov)
- Remove Stack service \#14078 (mkuznyetsov)
- compose plugin id \#14063 (sparkoo)
- Fix the list of workspaces in organization \#14058 (ashumilova)
- Add target="\_blank" to the link for "Make a wish" button. \#14037 (monaka)
- Make plugins/editors show one entry for each plugin with a drop down for version \#13942 (JPinkney)
- fix \#13660 - Replace mentions of 'oAuth', by more accurate 'OAuth'. \(See https://oauth.net/\) \#13664 (themr0c)


7.0.0-rc-4.0 (2019-07-25)


Full Changelog

Merged pull requests:

- RELEASE: Set next development version \#14026 (vparfonov)
- \[TS\_SELENIUM\] Resolve problem with notifications interaction \(bug \#13864\) \#14019 (Ohrimenko1988)
- Avoid using unsupported project's properties \#13998 (ashumilova)
- \[TS SELENIUM\] Fix the \#13865 issue \(Happy Path test is sometimes failing on "Error highlighting" step\) \#13987 (Ohrimenko1988)
- Add missing reference and referenceContent for action in DtoConverter \#13957 (sleshchenko)
- Remove the "npm" dependency vulnerability \#13948 (Ohrimenko1988)
- Store github token in session storage, remove on logout \#13947 (ashumilova)
- Fix project clonePath is not considered on workspace creation \#13923 (ashumilova)
- Set wildcard '\*' host name if key name start from 'default-' according to the the https://github.com/eclipse/che/issues/13494\#issuecomment-512761661 \#13901 (vparfonov)
- Add custom image with all required packages for init containers \#13900 (mshaposhnik)
- Helm chart deploy registries \#13890 (sparkoo)
- Adapt Java selenium e2e tests to Openshift OAuth v4 \#13887 (dmytro-ndp)
- \[TS-SELENIUM\] Adapt WorkspaceCreationAndLsInitialization test according workspace creation from Dashboard changes \#13885 (SkorikSergey)
- Selenium: Correct the e2e selenium tests related to changes on dashboard \#13884 (artaleks9)
- Mount the SSH keys as secrets in all workspace containers: OpenShift Env \#13883 (vparfonov)
- Set default version of Che Theia image \#13879 (vparfonov)
- Make name for SSH Key Config Map unique \#13877 (vparfonov)
- Deprecate /api/devfile REST API \#13868 (skabashnyuk)
- Store the container-machine mapping predictably \#13858 (metlos)
- \[TS-SELENIUM\] Fix HappyPath Java language server validation \#13851 (SkorikSergey)
- Stabilize part for waiting Dashboard in WorkspaceCreationAndLsInitialization test \#13850 (musienko-maxim)
- \[TS-SELENIUM\] Fix containers-happy-path.yaml reference url \#13831 (SkorikSergey)
- Adapt project selector widget to manage projects from devfile \#13825 (ashumilova)
- Remove Diagnostics widget on UD \#13815 (akurinnoy)
- fix\(helm\): Keep helm labels sync with che-operator so chectl is able to deploy multiuser without errors \#13812 (benoitf)
- Mount the SSH keys as secrets in all workspace containers \#13809 (vparfonov)
- Update the use of Machines in Che \#13808 (skabashnyuk)
- \[TS-SELENIUM\] Update HappyPath test according to fixed bug \#13802 (SkorikSergey)
- Add securityContext.fsGroup. \#13798 (monaka)
- \[keycloak\] Rename environment variables. \#13791 (monaka)
- Initial cleanup of che6 legacy code \#13788 (skabashnyuk)
- Update CODEOWNERS for the endgame \#13786 (l0rd)
- fix \#13660 - Replace mentions of 'oAuth', by more accurate 'OAuth'. \(See https://oauth.net/\) \#13664 (themr0c)

7.0.0-rc-3.0 (2019-07-05)


Full Changelog

Merged pull requests:

- chore\(github\): Update issue template to have several choices \#13777 (benoitf)
- RELEASE: Set next development version \#13711 (vparfonov)
- Revert "Fix handling of error status of a workspace " \#13699 (akurinnoy)
- \[E2E\] Change export logic \#13697 (Katka92)
- Set default Che Theia vesrsion to 7.0.0-rc-3.0 \#13696 (vparfonov)
- Updating codeowners for Che 7 endgame code reviews \#13684 (l0rd)
- \[Selenium\] Adapt selenium tests from ocpoauth package \#13663 (SkorikSergey)
- Set version 7.0.0-rc-3.0-SNAPSHOT \(rc in lowercase\) \#13655 (vparfonov)
- Remove Docker CLI and images parts of the CLI \#13652 (benoitf)
- Set new version 7.0.0-RC-3.0-SNAPSHOT \#13651 (vparfonov)
- modify url to get index.json \#13645 (tobespc)
- Workspace termination time metrics \#13635 (sparkoo)
- \[TS-SELENIUM\] Cover the "Use Java IDE features and the inner loop" step from "Happy path" scenario \#13615 (Ohrimenko1988)
- Deploy legacy variable only for che6 workspaces \#13612 (skabashnyuk)
- Fix the deployment failure with default values.yaml. \#13598 (monaka)
- Support mountSources for K8S/OS components in devfile \#13595 (mshaposhnik)
- Selenium: Update the E2E selenium tests according to the changes on dashboard \#13589 (artaleks9)
- Deprecate workspaces with Devfile stored as workspace config \#13588 (mkuznyetsov)
- Fix editor version in Che Devfile \#13572 (mkuznyetsov)
- Upgrade dashboard dependencies \#13571 (evidolob)
- Add dockerfile to execute E2E Che 7 typescript tests. \#13542 (Katka92)
- Apply TS formatter and linter to workspace-loader \#13532 (akurinnoy)

7.0.0-RC-1.1 (2019-06-19)


Full Changelog

Merged pull requests:

- Make Che Plugin Broker use self-signed certificate \#13565 (sleshchenko)
- RELEASE: Set next development version \#13564 (vparfonov)

7.0.0-RC-2.0 (2019-06-19)


Full Changelog

Merged pull requests:

- Fix the startup failure on the non-root runtime. \#13573 (monaka)
- Allow registry passwords longer than 128 chars \#13569 (johnmcollier)
- Update Openshift v4 provider download URL \#13567 (davidfestal)
- Operator-related fix and openshift v4 support \#13554 (davidfestal)
- \#13547 fix typo gralde \#13550 (nickboldt)
- Change plugin registry to v3 \#13548 (nickboldt)
- Add creation of k8s secrets during deploying of broker \#13546 (sleshchenko)
- \[E2E\] Update typescript tests according to workspace creation changes \#13544 (Ohrimenko1988)
- Fix handling of error status of a workspace \#13535 (akurinnoy)
- Remove non-null constraints from some devfile fields; \#13516 (mshaposhnik)
- Do not serialize DTO fields with empty or null objects and arrays \#13515 (mkuznyetsov)
- Use the metadata.name instead of name. \#13513 (metlos)
- Use memory limit provided by meta.yaml in apache-camel stack \#13505 (svor)
- Polishing of monitoring dashboards \#13501 (skabashnyuk)
- \[E2E typescript\] Fix plugins adding \#13496 (Katka92)
- K8s-like devfile naming \#13490 (metlos)
- \[TS-SELENIUM\] Cover the "Start a Workspace from a devfile" step from "Happy path" scenario \#13479 (Ohrimenko1988)
- Add devfile validation to /workspace/devfile endpoint \#13472 (metlos)
- Create workspace from devfile \#13469 (ashumilova)
- Selenium: remove selenium tests that check Che 6 compatible factories from CheSuite test suite \#13468 (SkorikSergey)
- Initialize the empty binding for allowed environment type upgrades in k8s infrastructure \#13466 (metlos)
- Rework dynamodule exclusion regexps to match nested WARs as well \#13464 (mkuznyetsov)
- RELEASE: Set next development version \#13460 (vparfonov)
- Adding owners for e2e directory. \#13457 (rhopp)
- \[E2E tests\] Changes needed to reuse the tests \#13456 (Katka92)
- Attempt to create the che project multiple times if it was previously deleted. \#13443 (metlos)
- Add possibility to specify reference or registry url for chePlugin/cheEditor type components \#13297 (mshaposhnik)
- Decoupled monitoring configuration and deployment \#13152 (skabashnyuk)

7.0.0-RC-1.0 (2019-06-03)


Full Changelog

Merged pull requests:

- Make workspace start errors more Che7 friendly \#13462 (skabashnyuk)
- Enable to set URLs for custom registries. \#13455 (monaka)
- Add -Duser.home parameter to maven opts in java-maven stack \#13453 (amisevsk)
- Fix handling no-environment in workspace config, introduced in Che7 \#13450 (ashumilova)
- CHE-12918 add checks for incompatible factories \#13446 (olexii4)
- Change version of redhat-java plugin to latest in stacks \#13440 (svor)
- Add PHP and PHP + MySQL Che-7 stacks with samples \#13434 (svor)
- Integrate Che Server with Devfile Registry \#13430 (sleshchenko)
- Merge api-devfile and api-workspace together \#13417 (metlos)

6.19.5 (2019-05-29)


Full Changelog

Merged pull requests:

- Fix templates for helm 2.14.0 \(validating option is enabled\) \#13432 (benoitf)
- Used latest keycloak 6.0.1 \#13429 (skabashnyuk)
- \[deploy/helm\] backport changes from chectl for templates \#13425 (benoitf)
- switch to RC version scheme \#13424 (riuvshin)
- Fix handling supported versions based on the devfile introduction \#13418 (ashumilova)
- Fix loader animation on factory loading page \#13415 (akurinnoy)
- Add an ability to disable waiting for PVCs to become bound \#13409 (sleshchenko)
- Add successful stopped workspaces metric \#13404 (mkuznyetsov)
- Remove dummy workspace config if devfile is present \#13403 (sleshchenko)
- Add preferences for chePlugin components in Devfile \#13341 (sleshchenko)

6.19.4 (2019-05-23)


Full Changelog

Merged pull requests:

- RELEASE: Update CHANGELOG \#13400 (riuvshin)
- Restore account linking on newest keycloak versions \#13398 (mshaposhnik)
- Fix selenium tests \#13371 (tolusha)

---

CONTRIBUTING

Contributing to Che

- Other Che repositories
- Devfile to contribute
- Contribute to ...
- Dashboard
- Che Server

Other Che repositories

Che is composed of multiple sub projects. For each projects we provide a CONTRIBUTE.md file describing how to setup the development environment to start your contribution. Most of the time, we encourage you to use Che to contribute to Che.

If creating a new repo under the eclipse-che or che-incubator organizations, you may need to upload a secret to enable GH actions and workflow automation. You can do so using github-secrets-generator. If using an existing secret, for example to enable the che-bot or che-incubator-bot, contact someone on the Che development team to get access to the current secret or token you need to upload.


Repository | Component | Description | Devfile | Documentation
--- | --- | --- | --- | ---
che | | (this repository) the main project repository | devfile | doc
---| tests | source code of our integration tests. | | |
che-server | | Che server project repository | devfile | doc
---| dockerfiles | source code, dockerfiles to build our main docker images. Note that Che-code related dockerfiles are located in che-code repo. | | |
---| che-server | orchestrates the Che workspaces with devfiles on Kubernetes | | |
---| tests | source code of our integration tests. | | |
chectl | | The CLI to install Che, create and start workspaces and devfiles | devfile | doc
che-code | | Fork of "Code - OSS" to work with Eclipse Che | devfile | doc
dashboard | | UI to manage workspaces, devfiles, etc. | devfile | doc
devfile-registry | | The default set of devfiles that would be made available on the Che dashboard stacks. | |
docs | | Eclipse Che documentation https://github.com/eclipse-che/che-docs source code. | devfile | doc
machine-exec | | Interface to execute tasks and terminals on other containers within a workspace. | devfile | doc
operator | | Che operator to deploy, update and manage K8S/OpenShift resources of Che. | devfile |
plugin-registry | | The default set of Che plugins (vscode extension + containers) or editors that could be installed on any Che workspaces. | |
website | | https://eclipse.dev/che website source code. | devfile |
workspace-client | | JS library to interact with a che-server. | |
configbump | | Simple Kubernetes controller that is able to quickly synchronize a set of config maps | |
workspace-data-sync | | Provides the ability to increase I/O performance for a developer workspaces | |
che-workspace-telemetry-client | | abstract telemetry API and a Typescript implementation of the API. | |
kubernetes-image-puller | | ensures that all nodes in the cluster have those images cached | |
blog | | Eclispe Che blog content. Get published at https://che.eclipseprojects.io/ | devfile |
che-docs-vale-style | | Vale style for Eclipse Che Documentation and related projects | |
che-release | | orchestration scripts for Eclipse Che artifacts and container images. | |
che-deploy-action | | GitHub action deploying Eclipse Che using chectl | |
devfile-converter | | Allow to convert Devfile v1 to v2 or v2 to v1 | |
happy-path-tests-action | | Run Happy Path tests as part of a Github action | |
header-rewrite-traefik-plugin | | Traefik plugin that can modify http headers. | |
jetbrains-editor-images | | Run JetBrains IDE remotely in Eclipse Che | |
kubernetes-image-puller-operator | | Install, configure, and manage the kubernetes-image-puller | |
devworkspace-operator | | Runs devfile based development environments on Kubernetes | |
registry | | Upstream devfile registry | |
developer-images | | Container images to code, build run applications on secured Kubernetes clusters | |
devworkspace-operator-docs | | DevWorkspace operator documentation | |
check-license-header | | License header format checker | |
devworkspace-telemetry-woopra-plugin | | Devworkspace telemetry Woopra plugin | |
setup-minikube-action | | Github action for starting Minikube to be able to Install/Run Eclipse Che | |
dependencies-license-action | | Github action to check file with list golang runtime dependencies and license information. | |
dash-licenses | | A container wrapper for The Eclipse Dash License Tool. | |
devfile-api | | Devfile API library | |


Devfile to contribute

We are trying to provide a devfile for each areas where you could contribute. Each devfile could be run on any Che instances to setup a ready-to-code developer environment. Beware that each of them may need a certain amount of memory.
Devfile could be launched through a factory or chectl cli.

bash
$ chectl workspace:start -f devfiles/che-theia-all.devfile.yaml

or

bash
$ chectl workspace:start -f https://raw.githubusercontent.com/eclipse/che-theia/main/devfiles/che-theia-all.devfile.yaml

or https://<CheInstance>/f?url=https://raw.githubusercontent.com/eclipse/che-theia/main/devfiles/che-theia-all.devfile.yaml

Contribute to ...

Let's cover the developer flow for these projects:

Che server


There is a devfile for development of Che server in Che.
To build Che one may run a predefined build task from the devfile.

Starting Che master requires some manual steps.
Open a terminal in runtime container (che-server-runtime) and perform:
- First, set CHE_HOME environment variable with absolute path to parent folder of Che master's Tomcat.
It might look like /projects/che/assembly/assembly-main/target/eclipse-che--SNAPSHOT/eclipse-che--SNAPSHOT.
- Then set CHE_HOST with the endpoint of new Che master.
If using the devfile the endpoint is che-dev and already set.
- After, set CHE_INFRASTRUCTURE_ACTIVE according to your environment.
For example: openshift (note, use kubernetes and openshift insted of minikube and minishift correspondingly).
- Run /entrypoint.sh.
After this, new Che master should be accesible from the che-dev endpoint.
To reach Swagger use url from che-dev endpoint with /swagger suffix.

To start a workspace from Che server under development some additional configuration of the cluster is needed.
One should add rights for the service account to be able to perform all needed for Che server actions.
Example for Openshift (in case of Kubernetes replace oc with kubectl):

bash
cat << EOF | oc apply -f -
apiVersion: rbac.authorization.k8s.io/v1
kind: RoleBinding
metadata:
labels:
app: che
component: che
name: che-workspace-admin
namespace: che
roleRef:
apiGroup: rbac.authorization.k8s.io
kind: ClusterRole
name: admin
subjects:
- kind: ServiceAccount
name: che-workspace
namespace: che
EOF

Also CHE_API_INTERNAL, CHE_API_EXTERNAL and CHE_API should be set in runner container and point to new Che server API.
If one uses provided devfile, they are already set to: http://che-dev:8080/api, which should be changed in case of https protocol.


Pull Request Template and its Checklist

Che repositories includes a GitHub Pull Request Template. Contributors must read and complete the template. In particular there is a list of requirements that the author needs to fulfil to merge the PR. This sections goes into the details of this checklist.

The Eclipse Contributor Agreement is valid

The author has completed the Eclipse Contributor Agreement and has signed the commits using his email.

Code produced is complete

No TODO comments left in the PR source code.

Code builds without errors

The author has verified that code builds, tests pass and linters are happy.

Tests are covering the bugfix or new feature

If the Pull Request fixes a bug, it must includes a new automated test. The test validates the fix and protect against future regressions.

If the Pull Request is for a new feature, it must include a new automated test. The test(s) validate the feature and protect against future regressions.

The repository devfile is up to date and works

The devfile commands used to build and run the application are still working.

Sections "What issues does this PR fix or reference" and "How to test this PR" completed

Never omit the two sections "What issues does this PR fix or reference" and "How to test this PR".

Relevant user documentation updated

The author has documented the changes to Che installation, usage or management in Che documentation.

Relevant contributing documentation updated

Document changes to the steps to contribute to the project in the CONTRIBUTING.md files.

CI/CD changes implemented, documented and communicated

Update CI/CD scripts and documentation when the PR includes changes to the build, test, distribute or deploy procedures. Communicate CI/CD changes to the whole community with an email.

---

README

<div id="header" align="center">

[](https://workspaces.openshift.com#https://github.com/eclipse-che/che)
&logo=eclipseche&color=FDB940&labelColor=525C86)

[](https://eclipse.dev/che/)

Platform for providing Kubernetes-based Cloud Development Environments for Enterprise Teams

[](https://github.com/codenvy/che/blob/master/LICENSE)
<a href="https://sonarcloud.io/dashboard?id=org.eclipse.che%3Ache-parent%3Amaster">
<img src="https://sonarcloud.io/images/project_badges/sonarcloud-black.svg" width="94" height="20" href="" />
</a>

Che is Kubernetes-native and places everything the developer needs into containers in Kube pods including dependencies, embedded containerized runtimes, a web IDE, and project code. This makes workspaces distributed, collaborative, and portable to run anywhere Kubernetes runs ... Read More

</div>

---

Visit website at: https://eclipse.dev/che/ and documentation at: https://eclipse.dev/che/docs

- Getting Started
- Using Eclipse Che
- Feedback and Community
- Contributing
- Roadmap
- License

---

Getting Started


Here you can find links on how to get started with Eclipse Che:
- Use Eclipse Che online
- Run Eclipse Che on your own Kubernetes cluster


Using Eclipse Che


Here you can find references to useful documentation and hands-on guides to learn how to get the most of Eclipse Che:
- Customize Che workspaces for your projects
- Automatically run VSCode Extensions in Che workspaces
- Starting a workspace from a Git repository URL
- Making a workspace portable using a devfile
- Configure your instance of Che using the CheCluster Kubernetes Custom Resource
- Use and customize the embedded VSCode extensions registry.

Feedback and Community


We love to hear from users and developers. Here are the various ways to get in touch with us:
* Support: You can ask questions, report bugs, and request features using GitHub issues.
* Public Chat: Join the public eclipse-che Slack channel to discuss with community and contributors.
* Twitter: @eclipse_che
* Mailing List: [email protected]
* Weekly Meetings: Join us in our Che community meeting every second monday.


Contributing


If you are interested in fixing issues and contributing directly to the code base:
- :bug: Submitting bugs
- :page_facing_up: Contributor license agreement
- :checkered_flag: Development workflows
- :pencil: Improve docs
- :building_construction: Che architecture
- :octocat: Che repositories
- :sparkles: Good first issue for new contributors


#### Extending Eclipse Che
- Customize the default dev tooling container (the universal developer image or UDI).
- Customize the list of getting started samples.
- Add your own editor definition.

Roadmap


We maintain the Che roadmap in the open way. We welcome anyone to ask question and contribute to the roadmap by joining our community meetings.

License


Eclipse Public License 2.0.

---