72 lines
2.2 KiB
Markdown
72 lines
2.2 KiB
Markdown
|
# Jira 上传附件 — 配置文件说明
|
||
|
|
|
||
|
|
本技能通过脚本 `scripts/upload_attachment.py` 将影响分析报告 MD 文件上传到 Jira Issue 附件（Atlassian MCP 插件不支持上传文件）。脚本从**配置文件**或环境变量读取 Jira 认证与站点信息，环境变量可覆盖配置文件中的同名项。
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## 配置文件方式（推荐）
|
||
|
|
|
||
|
|
### 1. 创建配置文件
|
||
|
|
|
||
|
|
在技能目录 `skills/g3fo-commit-jira/` 下放置 `jira_upload.env`，或复制示例后改名并填写真实值：
|
||
|
|
|
||
|
|
```powershell
|
||
|
|
# 在技能目录下
|
||
|
|
copy jira_upload.env.example jira_upload.env
|
||
|
|
# 编辑 jira_upload.env，填入 JIRA_BASE_URL、JIRA_EMAIL、JIRA_API_TOKEN
|
||
|
|
```
|
||
|
|
|
||
|
|
### 2. 文件格式
|
||
|
|
|
||
|
|
`jira_upload.env` 为 KEY=VALUE 格式，支持 `#` 注释：
|
||
|
|
|
||
|
|
```ini
|
||
|
|
# Jira 站点 URL，不要带末尾 /
|
||
|
|
JIRA_BASE_URL=https://你的站点.atlassian.net
|
||
|
|
# 登录邮箱
|
||
|
|
JIRA_EMAIL=你的邮箱@company.com
|
||
|
|
# API Token（在 Atlassian 账户设置中创建）
|
||
|
|
JIRA_API_TOKEN=你的 API Token
|
||
|
|
```
|
||
|
|
|
||
|
|
### 3. 指定配置文件路径
|
||
|
|
|
||
|
|
从仓库根目录执行时，建议用 `--config` 指定技能目录下的配置文件：
|
||
|
|
|
||
|
|
```powershell
|
||
|
|
python skills/g3fo-commit-jira/scripts/upload_attachment.py --config "skills/g3fo-commit-jira/jira_upload.env" --issue G3SF-123 --file "G3SF-123_Impact_Analysis.md"
|
||
|
|
```
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## 配置项说明
|
||
|
|
|
||
|
|
| 配置项 | 说明 | 示例 |
|
||
|
|
|--------|------|------|
|
||
|
|
| `JIRA_BASE_URL` | Jira 站点 URL，不要带末尾 `/` | `https://your-domain.atlassian.net` |
|
||
|
|
| `JIRA_EMAIL` | 登录 Jira 的邮箱 | `you@company.com` |
|
||
|
|
| `JIRA_API_TOKEN` | Jira 账户的 API Token | 在 [Atlassian API Tokens](https://id.atlassian.com/manage-profile/security/api-tokens) 创建 |
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## 环境变量覆盖
|
||
|
|
|
||
|
|
若同时存在配置文件和环境变量，**环境变量优先**。
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## API Token 获取
|
||
|
|
|
||
|
|
1. 打开 https://id.atlassian.com/manage-profile/security/api-tokens
|
||
|
|
2. 使用 Jira 登录邮箱登录
|
||
|
|
3. 点击 “Create API token”，命名后复制
|
||
|
|
4. Token 只显示一次，请妥善保存
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## 安全注意
|
||
|
|
|
||
|
|
- **不要将 `jira_upload.env` 提交到 Git**。技能目录下已通过 `.gitignore` 忽略。
|
||
|
|
- 不要将 `JIRA_API_TOKEN` 写入代码或提交到仓库。
|
||
|
|
- 定期在 Atlassian 账户中轮换 API Token。
|