KDE VS Code Extension
- The latest version of VS Code Extension (Version xxxx) offers these capabilities:
- Ability to view the pipelines, check the status and re-run the pipeline.
- Ability to view the APIs directly through the Swagger API and execute them. Note: If bearer token is available, only then the developer can see API response when executing the Swagger API.
Pre-requisite for Swagger APIs:
- Share an API definition from the direct Swagger URL without authentication (required to dynamically sync the APIs as the custom extension does not yet have an authentication mechanism built in).
- For API endpoints that can be accessed only with authentication / authorization, the extension will show or point to the static JSON file of APIs. So, the developer can only execute the APIs from VS Code but the API list will not be dynamically pulled.
Known limitations: Developer Console currently requires a bearer token, as the users of the VS Code custom extension are not authenticated or authorized. Only if bearer token is available, the developer can see API response when executing the Swagger API.
Download the KDE VS Code Extension and Readme file at the end of this section.
🚨 Note: Direct clicking is currently not working due to iframe restrictions and will be fixed in upcoming releases.
To open the link in a new tab:
- Desktop Browsers: Right-click the link and select “Open link in new tab” or use Ctrl/Cmd + Click.
- Touchscreen Devices: Long-press the link and choose "Open in new tab".
Pipeline log visibility
The KDE custom extension for IDEs (VSCode and JetBrains) supports pipeline log visibility, enabling developers to access, search, and manage pipeline job logs directly within their Integrated Development Environment (IDE). This feature enhances troubleshooting, auditing, and monitoring pipeline executions without requiring users to switch between tools.
The main features include:
- View logs: Open and review logs related to pipeline executions.
- Search logs: Find specific events or errors within the logs.
- Download and export: Save logs for further analysis or offline access.
- Terminal output: Logs are displayed in the IDE terminal and can be downloaded.
- Access control: Currently, users cannot delete the logs to maintain integrity, compliance and retention policies.
- Clipboard support (optional): Select, copy, and paste logs into separate files.
- Pipeline ID display: Unique identifier for each pipeline log.
The following log fields may be available, depending on IDE limitations:
- Timestamp of each event
- Pipeline Name & Run ID
- Stage/Step Identification
- Status Codes (Success/Error)
- Error Messages & Stack Traces
- Resource Utilization Metrics
- Duration of Processing Steps
- Input/Output Data Counts
- Transformation Details
- User/Service Account that triggered the run
- Environment Variables & Configuration
- Dependencies & Versions
Modularization to the IDE custom extension code for cross-IDE compatibility
The VS Code extension supports integration with JetBrains’ IntelliJ IDE, enhancing flexibility, maintainability and efficiency, while simplifying the extension’s adaptation to additional development environments.
The key benefits are:
- Cross-IDE compatibility: Modular design allows seamless adaptation of the extension to other IDEs with minimal rework.
- Simplified maintenance: Bugs and fixes can be addressed in a centralized manner, applying updates across all supported IDE versions.
- Faster development: Core functionalities can be reused, reducing the need to rebuild from scratch when adding new IDE support.
- Consistent user experience: Modularization ensures uniform behavior across different development environments through shared core components.
- Reduced testing burden: Core features require testing only once, with IDE-specific validation focused on integration points.
- Easier onboarding for contributors: Clear modular structure simplifies the process for external developers to contribute and expand IDE compatibility.
- Future-proofing: Adapting to new IDEs or major version updates becomes easier, requiring changes only in specific adapter modules.