https://github.com/postfinance/citrusframework-intellij-plugin
https://github.com/postfinance/citrusframework-intellij-plugin
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/postfinance/citrusframework-intellij-plugin
- Owner: postfinance
- Created: 2025-09-08T06:21:44.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2026-04-07T08:11:47.000Z (2 months ago)
- Last Synced: 2026-04-07T08:30:42.479Z (2 months ago)
- Language: Java
- Size: 2.07 MB
- Stars: 0
- Watchers: 0
- Forks: 1
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# citrusframework-intellij-plugin
[](https://plugins.jetbrains.com/plugin/MARKETPLACE_ID)
[](https://plugins.jetbrains.com/plugin/MARKETPLACE_ID)
## Template ToDo list
- [x] Create a new [IntelliJ Platform Plugin Template][template] project.
- [ ] Get familiar with the [template documentation][template].
- [ ] Adjust the [pluginGroup](./gradle.properties) and [pluginName](./gradle.properties), as well as the [id](./src/main/resources/META-INF/plugin.xml) and [sources package](./src/main/kotlin).
- [ ] Adjust the plugin description in `README` (see [Tips][docs:plugin-description])
- [ ] Review the [Legal Agreements](https://plugins.jetbrains.com/docs/marketplace/legal-agreements.html?from=IJPluginTemplate).
- [ ] [Publish a plugin manually](https://plugins.jetbrains.com/docs/intellij/publishing-plugin.html?from=IJPluginTemplate) for the first time.
- [ ] Set the `MARKETPLACE_ID` in the above README badges. You can obtain it once the plugin is published to JetBrains Marketplace.
- [ ] Set the [Plugin Signing](https://plugins.jetbrains.com/docs/intellij/plugin-signing.html?from=IJPluginTemplate) related [secrets](https://github.com/JetBrains/intellij-platform-plugin-template#environment-variables).
- [ ] Set the [Deployment Token](https://plugins.jetbrains.com/docs/marketplace/plugin-upload.html?from=IJPluginTemplate).
- [ ] Click the Watch button on the top of the [IntelliJ Platform Plugin Template][template] to be notified about releases containing new features and fixes.
- [ ] Configure the [CODECOV_TOKEN](https://docs.codecov.com/docs/quick-start) secret for automated test coverage reports on PRs
This is an IntelliJ plugin, that lets you run and debug XML Citrus Tests with one click.
This specific section is a source for the [plugin.xml](/src/main/resources/META-INF/plugin.xml) file which will be extracted by the [Gradle](/build.gradle.kts) during the build process.
To keep everything working, do not remove `` sections.
## Installation
- Using the IDE built-in plugin system:
Settings/Preferences > Plugins > Marketplace > Search for "citrusframework-intellij-plugin" >
Install
- Manually:
Download the [latest release](https://github.com/postfinance/citrusframework-intellij-plugin/releases/latest) and install it manually using
Settings/Preferences > Plugins > ⚙️ > Install plugin from disk...
## Using the plugin
In the project, **Right** click on the XML Citrus Test that you want to run.
In the Popup you will see two group of actions with a citrus logo called **Run XML Citrus Test** and **Debug XML Citrus Test**.
> Note that the plugin expects a minimum version of IntelliJ, see `gradle.properties` for the current number.
### Run XML Citrus Test
This group offers two possibilities for running one or more tests.
1. **Run XML Test**: Run the test(s) with a predefined Run Configuration.
2. **Select Run Configuration**: Select a Run Configuration before running the test(s).
### Debug XML Citrus Test
This group offers two possibilities for debugging one or more tests.
1. **Debug XML Test**: Debug the test(s) with a predefined Run Configuration.
2. **Select Run Configuration**: Select a Run Configuration before debugging the test(s).
---
Plugin based on the [IntelliJ Platform Plugin Template][template].
[template]: https://github.com/JetBrains/intellij-platform-plugin-template
[docs:plugin-description]: https://plugins.jetbrains.com/docs/intellij/plugin-user-experience.html#plugin-description-and-presentation