-
Notifications
You must be signed in to change notification settings - Fork 29
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Update versions to 0.9.0 - Update Metadata -Add changelog.md - Update LICENSE.md - Update Contributing.md (Remove mentions of spectrum and forum) - Update Secutiry.md
- Loading branch information
Showing
26 changed files
with
1,055 additions
and
373 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| # Eclipse GLSP Server Changelog | ||
|
|
||
| ## [v0.9.0- 09/12/2021](https://github.com/eclipse-glsp/glsp/releases/tag/0.9.0) | ||
|
|
||
| ### Changes | ||
|
|
||
| - [websocket] Fixed issue that was caused by reusing a shared injector for each client connection [#149](https://github.com/eclipse-glsp/glsp-server/pull/91) | ||
| - [navigation] Added a utility class for 'JsonOpenerOptions' [#153](https://github.com/eclipse-glsp/glsp-server/pulls?q=92+93) | ||
| - [diagram] Merged the `ServerLayoutConfiguration` API into the `DiagramConfiguration` API. [#123](https://github.com/eclipse-glsp/glsp-server/pull/95) | ||
| - [model] Reworked model update flow. All aspects of the update process are now handled by the `ModelSubmissionHandler` [#122](https://github.com/eclipse-glsp/glsp-server/pull/95) | ||
| - [model] Reworked and split `ModelFactory` API into a dedicated component responsible for loading the model source (`ModelSourceLoader`) and a component responsible for transforming the current modelstate into its GModel-representation (`GModelFactory`) [#119](https://github.com/eclipse-glsp/glsp-server/pull/96) | ||
| - [protocol] Added implementation for `SetViewportAction` [#179](https://github.com/eclipse-glsp/glsp-server/pull/99) | ||
| - [model] Introduced `GArgumentable` interface which is implemented by all `GModelElement`s. This can be used to provide additional information in form of an `args` map without having to extend the `GModel` type [#194](https://github.com/eclipse-glsp/glsp-server/pull/100) | ||
| - [model] Extended default type mapping and added builder for `GArgumentable` elements and corresponding utility classes [#180](https://github.com/eclipse-glsp/glsp-server/pull/105) | ||
| - [protocol] Added `fileUri` property to `SaveModelAction` and updated `SaveModelActionHandler` accordingly [#208](https://github.com/eclipse-glsp/glsp-server/pull/103/) | ||
| - [protocol] Added optional `reason` string property to `SetDirtyStateAction`. This property indicates the reason that caused to dirty state change and enables more fine granular handling of dirty state changes [#197](https://github.com/eclipse-glsp/glsp-server/pull/101) | ||
| - [build] Update dependencies of Google Guava (>= 30.1) and Google Guice (>= 5.0.0). [#260](https://github.com/eclipse-glsp/glsp-server/pull/119) | ||
| - [protocol] Refactor the base communication protocol to support initializing and disposing a client session. [#315](https://github.com/eclipse-glsp/glsp-server/pull/123) | ||
| - [server] The `org.apache.log4j` dependency is not reexported any more when consumed as p2 artifact. [#430](https://github.com/eclipse-glsp/glsp-eclipse-integration/pull/43) | ||
| - [di] Complete rework of DI architecture. Move away from one global injector per application. Instead use one global server injector and dedicated child injectors for each diagram session. [#150](https://github.com/eclipse-glsp/glsp-server/pull/127) | ||
| - [launch] Improve customizability of `DefaultGLSPServerLauncher`. [#385](https://github.com/eclipse-glsp/glsp-server/pull/128) | ||
| - [model] Add properties map in model state to store arbitrary properties that are persistent between handler calls. [#401](https://github.com/eclipse-glsp/glsp-server/pull/132) | ||
| - [server] Refactor json-rpc protocol and `DefaultGLSPServerImplementation`. [#421](https://github.com/eclipse-glsp/glsp-server/pull/133) | ||
| - [action] Rework `ActionHandler` & `OperationHandler` API. [#425](https://github.com/eclipse-glsp/glsp-server/pull/135) | ||
| - [action] Introduce `dispatchAfterNextUpdate` functionality for the `ActionDispatcher`. This enables queuing of actions until the next model updates has been processed. [#448](https://github.com/eclipse-glsp/glsp-server/pull/141/) | ||
| - [protocol] Align server-side action definitions with [protocol definition](https://github.com/eclipse-glsp/glsp/blob/master/PROTOCOL.md). [#432](https://github.com/eclipse-glsp/glsp-server/pull/142) | ||
|
|
||
| ### Breaking Changes | ||
|
|
||
| - [diagram] Merged the `ServerLayoutConfiguration` API into the `DiagramConfiguration` API. The standalone `ServerLayoutConfiguration` is now deprecated and no longer supported [#123](https://github.com/eclipse-glsp/glsp-server/pull/95) | ||
| - [model] Renamed `ModelFactory` to `ModelSourceLoader` and adapted interface method. This also affects implementing classes like the `JsonFileModelFactory` [#119](https://github.com/eclipse-glsp/glsp-server/pull/96) | ||
| - [model] Reworked `ModelSubmissionHandler` API. This includes changes of method names and parameters [#119](https://github.com/eclipse-glsp/glsp-server/pull/96) [#197](https://github.com/eclipse-glsp/glsp-server/pull/101) | ||
| - [build] Update dependencies of Google Guava (>= 30.1) and Google Guice (>= 5.0.0). [#260](https://github.com/eclipse-glsp/glsp-server/pull/119) | ||
| - [build] The `org.apache.log4j` dependency is not reexported any more when consumed as p2 artifact. You need to import `org.apache.log4j` in your own plugins if you use the log4j API there. [#430](https://github.com/eclipse-glsp/glsp-eclipse-integration/pull/43) | ||
| - [protocol] Refactor the base communication protocol to support initializing and disposing a client session. Remove now obsolete `InitializeClientSessionAction` and `DisposeClientSessionAction`. [#315](https://github.com/eclipse-glsp/glsp-server/pull/123) | ||
| - [di] Complete rework of DI architecture. Your main module now has to extend `DiagramModule` instead of `GLSPModule`. Includes restructurings,cleanups and refactorings that affect most of the API components. [#150](https://github.com/eclipse-glsp/glsp-server/pull/127) | ||
| - [server] Refactor json-rpc protocol and `DefaultGLSPServerImplementation`. This includes changes of method names and parameters [#421](https://github.com/eclipse-glsp/glsp-server/pull/133) | ||
|
|
||
| ## [v0.8.0 - 20/10/2020](https://github.com/eclipse-glsp/glsp/releases/tag/0.8.0) | ||
|
|
||
| This is the first release of Eclipse GLSP since it is hosted at the Eclipse Foundation. The 0.8.0 release includes new protocol message types and respective framework support for several new features, such as copy-paste, diagram navigation, etc. It also contains several clean-ups of the protocol and refactorings to simplify and streamline the API. The Eclipse Theia integration of GLSP features many improvements, such as problem marker integration, native context menu items and keybindings. Finally, several bug fixes and minor are part of this release as well. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,39 +1,46 @@ | ||
| # Contributing to Eclipse GLSP | ||
|
|
||
| Thank you for your interest in the GLSP project! The following is a set of guidelines for contributing to GLSP. | ||
| Thank you for your interest in the GLSP project! | ||
| The following is a set of guidelines for contributing to GLSP. | ||
|
|
||
| ## Code of Conduct | ||
|
|
||
| This project is governed by the [Eclipse Community Code of Conduct](https://github.com/eclipse/.github/blob/master/CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. | ||
| This project is governed by the [Eclipse Community Code of Conduct](https://github.com/eclipse/.github/blob/master/CODE_OF_CONDUCT.md). | ||
| By participating, you are expected to uphold this code. | ||
|
|
||
| ## Communication | ||
|
|
||
| The following communication channels are available: | ||
|
|
||
| * [GitHub issues](https://github.com/eclipse-glsp/glsp/issues) - for bug reports, feature requests, etc. | ||
| * [Spectrum chat](https://spectrum.chat/glsp/?tab=posts) - for questions | ||
| * [Eclipse community forum](https://www.eclipse.org/forums/index.php/f/465/) - for questions | ||
| * [Developer mailing list](https://accounts.eclipse.org/mailing-list/glsp-dev) - for organizational issues (e.g. elections of new committers) | ||
| * [GitHub issues](https://github.com/eclipse-glsp/glsp/issues) - for bug reports, feature requests, etc. | ||
| * [GitHub Discussions](https://github.com/eclipse-glsp/glsp/discussions) - for questions | ||
| * [Developer mailing list](https://accounts.eclipse.org/mailing-list/glsp-dev) - for organizational issues (e.g. elections of new committers) | ||
|
|
||
| In case you have a question, please look into the [documentation in the Wiki](https://github.com/eclipse-glsp/glsp/wiki) first. If you don't find any answer there, feel free to use the [chat](https://spectrum.chat/glsp/?tab=posts), [forum](https://www.eclipse.org/forums/index.php/f/465/) or [issues](https://github.com/eclipse-glsp/glsp/issues) to get help. | ||
| In case you have a question, please look into the [GitHub Discussions](https://github.com/eclipse-glsp/glsp/discussions) first. | ||
| If you don't find any answer there, feel free to start a new discussion or create a new [issue](https://github.com/eclipse-glsp/glsp/issues) to get help. | ||
|
|
||
| Please create new issues only in the [GLSP umbrella project](https://github.com/eclipse-glsp/glsp), as we are tracking the issues for all components of GLSP there. | ||
|
|
||
| ## How to Contribute | ||
|
|
||
| In order to contribute, please first open an issue in this project, irrespectively whether this bug or feature concerns the glsp-client, glsp-server, or one of the platform integrations. This issue should describe the bug you intend to fix or the feature you would like to add. | ||
| Once you have your code ready for review, please open a pull request in the respective repository. A [committer of the GLSP project](https://projects.eclipse.org/projects/ecd.glsp/who) will then review your contribution and help to get it merged. | ||
| In order to contribute, please first open an issue in this project, irrespectively whether this bug or feature concerns the glsp-client, glsp-server, or one of the platform integrations. | ||
| This issue should describe the bug you intend to fix or the feature you would like to add. | ||
| Once you have your code ready for review, please open a pull request in the respective repository. | ||
| A [committer of the GLSP project](https://projects.eclipse.org/projects/ecd.glsp/who) will then review your contribution and help to get it merged. | ||
|
|
||
| Please note that before your pull request can be accepted, you must electronically sign the [Eclipse Contributor Agreement](https://www.eclipse.org/legal/ECA.php). | ||
| For more information, see the [Eclipse Foundation Project Handbook](https://www.eclipse.org/projects/handbook/#resources-commit). | ||
|
|
||
| ### Branch names and commit messages | ||
|
|
||
| If you are an [elected committer of the GLSP project](https://projects.eclipse.org/projects/ecd.glsp/who) please create a branch in the respective repository. Otherwise please fork and create a branch in your fork for the pull request. | ||
| If you are an [elected committer of the GLSP project](https://projects.eclipse.org/projects/ecd.glsp/who) please create a branch in the respective repository. | ||
| Otherwise please fork and create a branch in your fork for the pull request. | ||
|
|
||
| The branch name should be in the form `issues/{issue_number}`, e.g. `issues/123`. So please create an issue before creating a pull request. | ||
| All branches with this naming schema will be deleted after they are merged. | ||
|
|
||
| In the commit message you should also reference the corresponding issue, e.g. using `closes https://github.com/eclipse-glsp/glsp/issues/241`, thus allowing [auto close of issues](https://help.github.com/en/github/managing-your-work-on-github/closing-issues-using-keywords). Please use the absolute URL of the issue instead of just `#241`, as all issues are kept in https://github.com/eclipse-glsp/glsp, whereas the pull requests are opened against the respective repositories, such as https://github.com/eclipse-glsp/glsp-client. Using the absolute URL will still allow to correctly reference issues irrespectively where you open the pull request. | ||
| In the commit message you should also reference the corresponding issue, e.g. using `closes https://github.com/eclipse-glsp/glsp/issues/241`, thus allowing [auto close of issues](https://help.github.com/en/github/managing-your-work-on-github/closing-issues-using-keywords). | ||
| Please use the absolute URL of the issue instead of just `#241`, as all issues are kept in <https://github.com/eclipse-glsp/glsp>, whereas the pull requests are opened against the respective repositories, such as <https://github.com/eclipse-glsp/glsp-client>. | ||
| Using the absolute URL will still allow to correctly reference issues irrespectively where you open the pull request. | ||
|
|
||
| Please make sure you read the [guide for a good commit message](https://chris.beams.io/posts/git-commit/). |
Oops, something went wrong.