@@ -221,8 +221,13 @@ maestro-mcp/
221221│ ├── server/ # HTTP server
222222│ └── vectordb/ # Vector database implementations
223223├── tests/ # Test files
224+ ├── .github/ # GitHub Actions workflows
225+ │ └── workflows/
226+ │ ├── ci.yml # Continuous Integration
227+ │ └── release.yml # Release automation
224228├── config.yaml # Configuration file
225229├── .env.example # Environment variables example
230+ ├── CHANGELOG.md # Changelog
226231├── build.sh # Build script
227232├── test.sh # Test script
228233├── start.sh # Start script
@@ -274,6 +279,40 @@ maestro-mcp/
274279./e2e.sh
275280```
276281
282+ ## CI/CD
283+
284+ This project uses GitHub Actions for continuous integration and deployment.
285+
286+ ### Continuous Integration
287+
288+ The CI pipeline runs on every push and pull request and includes:
289+
290+ - ** Linting** : Code quality checks with golangci-lint, gofmt, and shellcheck
291+ - ** Building** : Compilation for multiple platforms (Linux, macOS, Windows)
292+ - ** Testing** : Unit tests, integration tests, and end-to-end tests
293+ - ** Security** : Vulnerability scanning with gosec and govulncheck
294+ - ** Matrix Testing** : Cross-platform testing with multiple Go versions
295+
296+ ### Release Automation
297+
298+ The release workflow automatically:
299+
300+ - ** Triggers** : On git tags (e.g., ` v1.0.0 ` ) or manual dispatch
301+ - ** Tests** : Runs full test suite before release
302+ - ** Builds** : Creates binaries for multiple platforms
303+ - ** Packages** : Generates checksums and release notes
304+ - ** Publishes** : Creates GitHub release with downloadable assets
305+
306+ ### Workflow Files
307+
308+ - ` .github/workflows/ci.yml ` : Main CI pipeline
309+ - ` .github/workflows/release.yml ` : Release automation
310+
311+ ### Status Badges
312+
313+ [ ![ CI] ( https://github.com/maximilien/maestro-mcp/workflows/CI/badge.svg )] ( https://github.com/maximilien/maestro-mcp/actions )
314+ [ ![ Release] ( https://github.com/maximilien/maestro-mcp/workflows/Release/badge.svg )] ( https://github.com/maximilien/maestro-mcp/actions )
315+
277316### Server Management
278317
279318``` bash
@@ -424,6 +463,32 @@ Security features include:
424463- ** Rate Limiting** : Configurable rate limits for API endpoints
425464- ** Authentication** : Support for API keys and custom authentication
426465
466+ ## Releases
467+
468+ ### Download
469+
470+ Download the latest release from the [ Releases page] ( https://github.com/maximilien/maestro-mcp/releases ) .
471+
472+ ### Supported Platforms
473+
474+ - ** Linux** : amd64, arm64
475+ - ** macOS** : amd64, arm64 (Apple Silicon)
476+ - ** Windows** : amd64
477+
478+ ### Installation
479+
480+ 1 . Download the appropriate binary for your platform
481+ 2 . Make it executable: ` chmod +x maestro-mcp-* `
482+ 3 . Run: ` ./maestro-mcp-* `
483+
484+ ### Verification
485+
486+ Verify the integrity of your download using the checksums provided in each release:
487+
488+ ``` bash
489+ sha256sum -c checksums.txt
490+ ```
491+
427492## Contributing
428493
4294941 . Fork the repository
@@ -432,7 +497,8 @@ Security features include:
4324974 . Add tests for new functionality
4334985 . Run the test suite: ` ./test.sh all `
4344996 . Run the linter: ` ./lint.sh `
435- 7 . Submit a pull request
500+ 7 . Ensure CI passes
501+ 8 . Submit a pull request
436502
437503## License
438504
0 commit comments