Devops Mcps

🚀 プロジェクトドキュメント

このプロジェクトは、GitHubコード検索、Jenkinsタスク管理、Slack通知統合などの機能を提供し、DevOpsの自動化と管理を支援します。

🚀 クイックスタート

このセクションでは、プロジェクトのインストール方法と基本的な使用方法を紹介します。

📦 インストール

最新バージョンのインストール

最新バージョンを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

使用ガイド

主要機能

1. GitHubコード検索：GitHub APIを使用して特定のリポジトリまたはコードスニペットを検索します。

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

2. Jenkinsタスク管理：Jenkinsのビルドジョブを監視および管理します。

devops-mcps jenkins-job status --job_name my_job

3. 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.

付録

ツール依存関係

• Python: 3.8+
• Jenkins API Client: Jenkinsサーバーとのやり取りに使用されます。
• Slack API Wrapper: Slackボット機能を統合します。

貢献者

以下の貢献者に感謝します。

• Your Name
• Contributor 1

詳細情報

プロジェクトの公式サイトはこちらです。 https://devops-mcps.readthedocs.io