Jenkins插件技术文档

1. 安装指南

从IDE中下载此插件，或从插件网站下载。

2. 使用说明

配置步骤

• 点击位于工具栏上方的“Jenkins设置”按钮，或在IntelliJ设置屏幕中选择Jenkins插件部分。
• 配置分为两个区域。第一个用于更改行为设置，第二个用于服务器设置。
• 在“服务器”中输入Jenkins服务器的URL（例如：https://ci.jenkins.io/）。
• 如果服务器启用了安全性，则需要提供凭据。输入用户名和API令牌。
  • 自Jenkins 2.176起，建议使用API令牌来认证插件：
    1. 转到用户设置： _jenkins_url_/user/_username_/configure
    2. 添加新的API令牌（建议为Jenkins插件创建一个新的API令牌）
    3. 使用新添加的API令牌
• 确保所有参数正确后，可以点击“测试连接”按钮。会出现反馈信息。
• 如果服务器响应为401或403，将出现调试面板。

使用方式

• 要查看作业，需要刷新Jenkins工作区，方法是右键点击服务器图标节点。
• 可以从组合框中选择视图。
• 右键点击作业时，会出现一些选项，如启动构建、查看作业页面和查看最后构建结果。
• 可以按状态（失败、不稳定、已禁用/已取消、成功）对构建进行排序。
• 要搜索特定作业，只需在浏览器中开始输入并使用上下键导航。
• 可以将某些作业设置为收藏。

3. API使用文档

本插件目前未提供直接的API接口文档。用户可以通过阅读插件的源代码或查看Jenkins的相关API文档来获取更多信息。

4. 项目安装方式

此项目使用Gradle构建。构建插件的方法是运行./gradlew buildPlugin。要导入插件源代码到IntelliJ IDEA中，需要将其作为Gradle项目导入，并创建一个Gradle运行配置来运行runIdea任务。