Devops Mcps

🚀 項目文檔

本項目 devops-mcps 是一個用於DevOps相關操作的工具，集成了GitHub代碼搜索、Jenkins任務管理和Slack通知等功能，能有效提升開發和運維的工作效率。

🚀 快速開始

你可以根據自己的需求，選擇合適的方式安裝 devops-mcps。

📦 安裝指南

使用pip安裝最新版本

pip install devops-mcps

指定版本安裝

pip install "devops-mcps==0.15.0"

從源碼安裝

git clone https://github.com/your-org/devops-mcps.git
cd devops-mcps
python -m pip install -e .

📚 詳細文檔

配置指南

環境變量

項目依賴以下環境變量：

• GITHUB_API_TOKEN：GitHub API訪問令牌，用於GitHub搜索功能。
• JENKINS_SERVER_URL：Jenkins服務器URL地址。
• SLACK_WEBHOOK_URL：Slack機器人Webhook URL。

日誌配置

日誌默認輸出到控制檯。如需調整日誌級別或格式，請編輯logging.ini文件：

[loggers]
keys = root, devops_mcps

[handlers]
keys = consoleHandler

[formatters]
keys = simpleFormatter

[logger_root]
level = NOTSET
handlers =
qualname =

[logger_devops_mcps]
level = INFO
handlers = consoleHandler
qualname = devops_mcps

[handler_consoleHandler]
class = StreamHandler
level = NOTSET
formatter = simpleFormatter
args = (sys.stderr,)

[formatter_simpleFormatter]
format = %(asctime)s - %(levelname)-5s - %(module)s:%(lineno)d - %(message)s
datefmt = %H:%M:%S

開發指南

項目結構

src/
├── devops_mcps/
│   ├── __init__.py
│   ├── cli.py
│   └── services/
│       ├── jenkins_service.py
│       └── slack_notifier.py
tests/
├── test_cli.py
└── test_jenkins_service.py

依賴管理

使用uv進行依賴管理：

# 安裝基本依賴
uv pip install -r requirements.txt

# 同步鎖定文件
uv lock update

💻 使用示例

核心功能

GitHub代碼搜索

通過GitHub API搜索特定倉庫或代碼片段。

devops-mcps gh-search-code --query "fastapi" --language python

Jenkins任務管理

監控和管理Jenkins構建作業。

devops-mcps jenkins-job status --job_name my_job

Slack通知集成

將項目狀態或錯誤信息發送到Slack頻道。

devops-mcps slack notify --message "構建完成，請檢查結果"

貢獻指南

提交規範

遵循Conventional Commits規範進行代碼提交。

問題報告

如遇問題，請訪問GitHub Issues頁面提交： https://github.com/your-org/devops-mcps/issues

測試指南

單元測試

運行所有單元測試：

pytest tests/

指定測試模塊運行：

pytest tests/test_cli.py -v

生成測試報告：

coverage run -m pytest tests/ && coverage report

集成測試

集成測試配置在tests/integration_test.py文件中，需確保已配置好相關環境變量。

持續集成

項目使用GitHub Actions進行持續集成。以下是主要工作流配置：

name: CI-CD

on:
  push:
    branches: [ main ]
  pull_request:

jobs:
  build-and-test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      
      - name: Set up Python
        uses: actions/setup-python@v3
      
      - name: Install dependencies
        run: pip install -r requirements.txt
        
      - name: Run tests
        run: pytest --cov .

📄 許可證

本項目遵循MIT License協議。具體許可證內容如下：

The MIT License (MIT)
Copyright (c) 2023 Your Name
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

附錄

工具依賴

貢獻者

感謝以下貢獻者：

• Your Name
• Contributor 1

更多信息

項目官網：https://devops-mcps.readthedocs.io