Devops Mcps

🚀 DevOps MCPS Project

DevOps MCPS is a toolset designed to streamline development operations, integrating GitHub code search, Jenkins job management, and Slack notification features.

🚀 Quick Start

To quickly start using DevOps MCPS, you need to install and configure it. The following are the installation and configuration steps.

📦 Installation

You can choose one of the following methods to install DevOps MCPS:

Install the latest version using pip

pip install devops-mcps

Install a specific version

pip install "devops-mcps==0.15.0"

Install from source code

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

📚 Documentation

Configuration Guide

Environment Variables

The project depends on the following environment variables:

• GITHUB_API_TOKEN: GitHub API access token for the GitHub search function.
• JENKINS_SERVER_URL: The URL address of the Jenkins server.
• SLACK_WEBHOOK_URL: The Webhook URL of the Slack bot.

Log Configuration

Logs are output to the console by default. If you need to adjust the log level or format, edit the logging.ini file:

[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

Development Guide

Project Structure

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

Dependency Management

Use uv for dependency management:

# Install basic dependencies
uv pip install -r requirements.txt

# Synchronize the lock file
uv lock update

Usage Instructions

Core Features

1. GitHub Code Search: Search for specific repositories or code snippets through the GitHub API.

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

2. Jenkins Job Management: Monitor and manage Jenkins build jobs.

devops-mcps jenkins-job status --job_name my_job

3. Slack Notification Integration: Send project status or error information to the Slack channel.

devops-mcps slack notify --message "Build completed, please check the results"

Contribution Guide

Commit Specification

Follow the Conventional Commits specification for code commits.

Issue Reporting

If you encounter any issues, please visit the GitHub Issues page to submit them: https://github.com/your-org/devops-mcps/issues

Testing Guide

Unit Tests

Run all unit tests:

pytest tests/

Run a specific test module:

pytest tests/test_cli.py -v

Generate a test report:

coverage run -m pytest tests/ && coverage report

Integration Tests

Integration tests are configured in the tests/integration_test.py file. Make sure you have configured the relevant environment variables.

Continuous Integration

The project uses GitHub Actions for continuous integration. The following is the main workflow configuration:

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 .

📄 License

This project follows the MIT License. The specific license content is as follows:

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.

Appendix

Tool Dependencies

Contributors

Thanks to the following contributors:

• Your Name
• Contributor 1

More Information

Project official website: https://devops-mcps.readthedocs.io