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

Documentation for developers to understand continuous build integration #990

Merged
merged 12 commits into from
Sep 27, 2024
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,10 @@

Liberty Tools for IntelliJ IDEA is an IntelliJ IDEA plugin for developing cloud-native Java applications with [Open Liberty](https://openliberty.io/) and [WebSphere Liberty](https://www.ibm.com/products/websphere-liberty). Iterate fast with Liberty dev mode, code with assistance for MicroProfile and Jakarta EE APIs, and easily edit Liberty configuration files.

Liberty Tools for IntelliJ includes LSP4IJ, an external plugin dependency that is automatically installed with LTI. LSP4IJ is a free and open-source Language Server Protocol (LSP) client developed by Red Hat, enabling seamless language server integration.
anusreelakshmi934 marked this conversation as resolved.
Show resolved Hide resolved

Users who wish to change the version of LSP4IJ installed along with LTI can refer to this resource [here](docs/user-guide.md#manually-install-specific-release-of-the-lsp4ij-plugin-from-the-marketplace).
anusreelakshmi934 marked this conversation as resolved.
Show resolved Hide resolved

![Liberty Tools Extension](docs/images/liberty-tool-window-view.png)

---
Expand Down
322 changes: 322 additions & 0 deletions docs/LSP4IJ-Integration.md
anusreelakshmi934 marked this conversation as resolved.
Show resolved Hide resolved

Large diffs are not rendered by default.

Binary file added docs/images/Artifact-names.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/Build-artifacts.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/Normal-builds.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/Pr-details.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/Test-reports.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/Workflow-dispatch.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/build-results-slack-view.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/example-manually-trigger.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/manually-trigger.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/result-cron-job.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/specify-LTI-tags-branches.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/version.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
20 changes: 20 additions & 0 deletions docs/user-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ For information regarding known issues and limitations, refer to our [Common Iss
- [Software requirements](#software-requirements)
- [Application requirements](#application-requirements)
- [Settings](#settings)
- [Manually install specific release of the LSP4IJ plugin from the Marketplace](#manually-install-specific-release-of-the-lsp4ij-plugin-from-the-marketplace)
- [Open the Liberty tool window](#open-the-liberty-tool-window)
- [Run your application on Liberty using dev mode](#run-your-application-on-liberty-using-dev-mode)
- [Use the Liberty tool window](#use-the-liberty-tool-window)
Expand Down Expand Up @@ -50,6 +51,25 @@ Liberty Tools for IntelliJ IDEA honors the following settings:
#### Environment Variables:
- The **JAVA_HOME** system environment variable in the current terminal is used when you run Liberty dev mode in any project.

## Manually install specific release of the LSP4IJ plugin from the Marketplace

When installing the LTI Plugin, the latest version of LSP4IJ from the marketplace will be installed by default.
anusreelakshmi934 marked this conversation as resolved.
Show resolved Hide resolved

If you prefer to use an older version of LSP4IJ (e.g., the specific version that was tested with the LTI release you are using), you can manually downgrade it by installing the desired version as a dependency from the Marketplace. Link to download a specific LSP4IJ version - https://plugins.jetbrains.com/plugin/23257-lsp4ij/versions
anusreelakshmi934 marked this conversation as resolved.
Show resolved Hide resolved


Steps to install an older version of LSP4IJ:
1. Go to the Plugins tab in the IDE Settings and uninstall the latest version.

2. Download the desired version from the provided link above; it will be saved as a zip file.

3. Reopen the IDE settings and navigate to the Plugins section.

4. Click the gear icon, then select "Install Plugin from Disk," and choose the downloaded zip file.
<img alt="Install Plugin from disk" height="300" src="images/LSP4IJ-Install Plugin from disk.png" width="350"/>

5. Confirm by clicking OK, then apply the changes. If prompted, restart your IDE.

## Open the Liberty tool window
Select **View > Tool Windows > Liberty**.

Expand Down
Loading