Compare commits
1 Commits
v1.0.63
...
feat/54-li
| Author | SHA1 | Date | |
|---|---|---|---|
| 3af10a3844 |
13
.env.example
13
.env.example
@ -1,13 +0,0 @@
|
||||
# GitLab API Configuration
|
||||
GITLAB_API_URL=https://gitlab.com
|
||||
GITLAB_TOKEN=your-gitlab-personal-access-token-here
|
||||
|
||||
# Test Configuration (for integration tests)
|
||||
GITLAB_TOKEN_TEST=your-test-token-here
|
||||
TEST_PROJECT_ID=your-test-project-id
|
||||
ISSUE_IID=1
|
||||
|
||||
# Proxy Configuration (optional)
|
||||
HTTP_PROXY=
|
||||
HTTPS_PROXY=
|
||||
NO_PROXY=localhost,127.0.0.1
|
||||
@ -1,24 +0,0 @@
|
||||
{
|
||||
"parser": "@typescript-eslint/parser",
|
||||
"extends": ["eslint:recommended", "plugin:@typescript-eslint/recommended"],
|
||||
"plugins": ["@typescript-eslint"],
|
||||
"parserOptions": {
|
||||
"ecmaVersion": 2022,
|
||||
"sourceType": "module"
|
||||
},
|
||||
"env": {
|
||||
"node": true,
|
||||
"es2022": true,
|
||||
"jest": true
|
||||
},
|
||||
"rules": {
|
||||
"no-console": "warn",
|
||||
"prefer-const": "error",
|
||||
"no-unused-vars": "off",
|
||||
"@typescript-eslint/no-unused-vars": ["error", { "argsIgnorePattern": "^_" }],
|
||||
"@typescript-eslint/explicit-module-boundary-types": "off",
|
||||
"@typescript-eslint/no-explicit-any": "warn",
|
||||
"@typescript-eslint/no-non-null-assertion": "warn"
|
||||
},
|
||||
"ignorePatterns": ["node_modules/", "build/", "coverage/", "*.js"]
|
||||
}
|
||||
96
.github/pr-validation-guide.md
vendored
96
.github/pr-validation-guide.md
vendored
@ -1,96 +0,0 @@
|
||||
# PR Validation Guide
|
||||
|
||||
## Overview
|
||||
|
||||
All Pull Requests are now automatically tested and validated. Manual testing is no longer required!
|
||||
|
||||
## Automated Validation Items
|
||||
|
||||
### 1. Build and Type Check
|
||||
|
||||
- TypeScript compilation success
|
||||
- No type errors
|
||||
|
||||
### 2. Testing
|
||||
|
||||
- **Unit Tests**: API endpoints, error handling, authentication, etc.
|
||||
- **Integration Tests**: Real GitLab API integration (when environment variables are set)
|
||||
- **Code Coverage**: Test coverage report generation
|
||||
|
||||
### 3. Code Quality
|
||||
|
||||
- **ESLint**: Code style and potential bug detection
|
||||
- **Prettier**: Code formatting consistency
|
||||
- **Security Audit**: npm package vulnerability scanning
|
||||
|
||||
### 4. Docker Build
|
||||
|
||||
- Dockerfile build success
|
||||
- Container startup validation
|
||||
|
||||
### 5. Node.js Version Compatibility
|
||||
|
||||
- Tested across Node.js 18.x, 20.x, and 22.x
|
||||
|
||||
## GitHub Secrets Setup (Optional)
|
||||
|
||||
To enable integration tests, configure these secrets:
|
||||
|
||||
1. `GITLAB_TOKEN_TEST`: GitLab Personal Access Token
|
||||
2. `TEST_PROJECT_ID`: Test GitLab project ID
|
||||
3. `GITLAB_API_URL`: GitLab API URL (default: https://gitlab.com)
|
||||
|
||||
## Running Validation Locally
|
||||
|
||||
You can run validation locally before submitting a PR:
|
||||
|
||||
```bash
|
||||
# Run all validations
|
||||
./scripts/validate-pr.sh
|
||||
|
||||
# Run individual validations
|
||||
npm run test # All tests
|
||||
npm run test:unit # Unit tests only
|
||||
npm run test:coverage # With coverage
|
||||
npm run lint # ESLint
|
||||
npm run format:check # Prettier check
|
||||
```
|
||||
|
||||
## PR Status Checks
|
||||
|
||||
When you create a PR, these checks run automatically:
|
||||
|
||||
- ✅ test (18.x)
|
||||
- ✅ test (20.x)
|
||||
- ✅ test (22.x)
|
||||
- ✅ integration-test
|
||||
- ✅ code-quality
|
||||
- ✅ coverage
|
||||
|
||||
All checks must pass before merging is allowed.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Test Failures
|
||||
|
||||
1. Check the failed test in the PR's "Checks" tab
|
||||
2. Review specific error messages in the logs
|
||||
3. Run the test locally to debug
|
||||
|
||||
### Formatting Errors
|
||||
|
||||
```bash
|
||||
npm run format # Auto-fix formatting
|
||||
npm run lint:fix # Auto-fix ESLint issues
|
||||
```
|
||||
|
||||
### Type Errors
|
||||
|
||||
```bash
|
||||
npx tsc --noEmit # Run type check only
|
||||
```
|
||||
|
||||
## Dependabot Auto-merge
|
||||
|
||||
- Minor and patch updates are automatically merged
|
||||
- Major updates require manual review
|
||||
30
.github/workflows/auto-merge.yml
vendored
30
.github/workflows/auto-merge.yml
vendored
@ -1,30 +0,0 @@
|
||||
name: Auto Merge Dependabot PRs
|
||||
|
||||
on:
|
||||
pull_request:
|
||||
types: [opened, synchronize, reopened]
|
||||
|
||||
permissions:
|
||||
contents: write
|
||||
pull-requests: write
|
||||
|
||||
jobs:
|
||||
auto-merge:
|
||||
runs-on: ubuntu-latest
|
||||
if: github.actor == 'dependabot[bot]'
|
||||
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Dependabot metadata
|
||||
id: metadata
|
||||
uses: dependabot/fetch-metadata@v2
|
||||
with:
|
||||
github-token: "${{ secrets.GITHUB_TOKEN }}"
|
||||
|
||||
- name: Auto-merge minor updates
|
||||
if: steps.metadata.outputs.update-type == 'version-update:semver-minor' || steps.metadata.outputs.update-type == 'version-update:semver-patch'
|
||||
run: gh pr merge --auto --merge "${{ github.event.pull_request.number }}"
|
||||
env:
|
||||
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
39
.github/workflows/docker-publish.yml
vendored
39
.github/workflows/docker-publish.yml
vendored
@ -1,39 +0,0 @@
|
||||
name: Docker Publish
|
||||
|
||||
on:
|
||||
release:
|
||||
types: [published]
|
||||
|
||||
jobs:
|
||||
docker:
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Set up Docker Buildx
|
||||
uses: docker/setup-buildx-action@v3
|
||||
|
||||
- name: Login to Docker Hub
|
||||
uses: docker/login-action@v3
|
||||
with:
|
||||
username: ${{ secrets.DOCKERHUB_USERNAME }}
|
||||
password: ${{ secrets.DOCKERHUB_TOKEN }}
|
||||
|
||||
- name: Extract metadata for Docker
|
||||
id: meta
|
||||
uses: docker/metadata-action@v5
|
||||
with:
|
||||
images: ${{ secrets.DOCKERHUB_USERNAME }}/gitlab-mcp
|
||||
tags: |
|
||||
type=semver,pattern={{version}}
|
||||
latest
|
||||
|
||||
- name: Build and push Docker image
|
||||
uses: docker/build-push-action@v5
|
||||
with:
|
||||
context: .
|
||||
platforms: linux/amd64,linux/arm64
|
||||
push: true
|
||||
tags: ${{ steps.meta.outputs.tags }}
|
||||
163
.github/workflows/pr-test.yml
vendored
163
.github/workflows/pr-test.yml
vendored
@ -1,163 +0,0 @@
|
||||
name: PR Test and Validation
|
||||
|
||||
on:
|
||||
pull_request:
|
||||
branches: [ main ]
|
||||
types: [opened, synchronize, reopened]
|
||||
|
||||
jobs:
|
||||
test:
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
strategy:
|
||||
matrix:
|
||||
node-version: [18.x, 20.x, 22.x]
|
||||
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Setup Node.js ${{ matrix.node-version }}
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: ${{ matrix.node-version }}
|
||||
cache: 'npm'
|
||||
|
||||
- name: Install dependencies
|
||||
run: npm ci
|
||||
|
||||
- name: Build project
|
||||
run: npm run build
|
||||
|
||||
- name: Run tests
|
||||
run: npm test
|
||||
env:
|
||||
GITLAB_API_URL: ${{ secrets.GITLAB_API_URL }}
|
||||
GITLAB_TOKEN: ${{ secrets.GITLAB_TOKEN_TEST }}
|
||||
GITLAB_PERSONAL_ACCESS_TOKEN: ${{ secrets.GITLAB_PERSONAL_ACCESS_TOKEN }}
|
||||
|
||||
- name: Type check
|
||||
run: npx tsc --noEmit
|
||||
|
||||
- name: Lint check
|
||||
run: npm run lint || echo "No lint script found"
|
||||
|
||||
- name: Check package size
|
||||
run: |
|
||||
npm pack --dry-run
|
||||
echo "Package created successfully"
|
||||
|
||||
- name: Security audit
|
||||
run: npm audit --production || echo "Some vulnerabilities found"
|
||||
continue-on-error: true
|
||||
|
||||
- name: Test MCP server startup
|
||||
run: |
|
||||
echo "MCP server startup test temporarily disabled for debugging"
|
||||
echo "GITLAB_PERSONAL_ACCESS_TOKEN is: ${GITLAB_PERSONAL_ACCESS_TOKEN:0:10}..."
|
||||
env:
|
||||
GITLAB_API_URL: ${{ secrets.GITLAB_API_URL }}
|
||||
GITLAB_TOKEN: ${{ secrets.GITLAB_TOKEN_TEST }}
|
||||
GITLAB_PERSONAL_ACCESS_TOKEN: ${{ secrets.GITLAB_PERSONAL_ACCESS_TOKEN }}
|
||||
|
||||
integration-test:
|
||||
runs-on: ubuntu-latest
|
||||
needs: test
|
||||
if: github.event.pull_request.draft == false
|
||||
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Setup Node.js
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: '20.x'
|
||||
cache: 'npm'
|
||||
|
||||
- name: Install dependencies
|
||||
run: npm ci
|
||||
|
||||
- name: Build project
|
||||
run: npm run build
|
||||
|
||||
- name: Run integration tests
|
||||
if: ${{ github.event_name == 'push' || github.event.pull_request.head.repo.full_name == github.repository }}
|
||||
run: |
|
||||
echo "Running integration tests with real GitLab API..."
|
||||
npm run test:integration || echo "No integration test script found"
|
||||
env:
|
||||
GITLAB_API_URL: ${{ secrets.GITLAB_API_URL }}
|
||||
GITLAB_TOKEN: ${{ secrets.GITLAB_TOKEN_TEST }}
|
||||
GITLAB_PERSONAL_ACCESS_TOKEN: ${{ secrets.GITLAB_PERSONAL_ACCESS_TOKEN }}
|
||||
PROJECT_ID: ${{ secrets.TEST_PROJECT_ID }}
|
||||
|
||||
- name: Test Docker build
|
||||
run: |
|
||||
docker build -t mcp-gitlab-test .
|
||||
docker run --rm mcp-gitlab-test node build/index.js --version || echo "Version check passed"
|
||||
|
||||
code-quality:
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
fetch-depth: 0
|
||||
|
||||
- name: Setup Node.js
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: '20.x'
|
||||
cache: 'npm'
|
||||
|
||||
- name: Install dependencies
|
||||
run: npm ci
|
||||
|
||||
- name: Check code formatting
|
||||
run: |
|
||||
npx prettier --check "**/*.{js,ts,json,md}" || echo "Some files need formatting"
|
||||
|
||||
- name: Check for console.log statements
|
||||
run: |
|
||||
if grep -r "console\.log" --include="*.ts" --exclude-dir=node_modules --exclude-dir=build --exclude="test*.ts" .; then
|
||||
echo "⚠️ Found console.log statements in source code"
|
||||
else
|
||||
echo "✅ No console.log statements found"
|
||||
fi
|
||||
|
||||
- name: Check for TODO comments
|
||||
run: |
|
||||
if grep -r "TODO\|FIXME\|XXX" --include="*.ts" --exclude-dir=node_modules --exclude-dir=build .; then
|
||||
echo "⚠️ Found TODO/FIXME comments"
|
||||
else
|
||||
echo "✅ No TODO/FIXME comments found"
|
||||
fi
|
||||
|
||||
coverage:
|
||||
runs-on: ubuntu-latest
|
||||
if: github.event.pull_request.draft == false
|
||||
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Setup Node.js
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: '20.x'
|
||||
cache: 'npm'
|
||||
|
||||
- name: Install dependencies
|
||||
run: npm ci
|
||||
|
||||
- name: Build project
|
||||
run: npm run build
|
||||
|
||||
- name: Run tests
|
||||
run: npm test
|
||||
env:
|
||||
GITLAB_API_URL: ${{ secrets.GITLAB_API_URL }}
|
||||
GITLAB_TOKEN_TEST: ${{ secrets.GITLAB_TOKEN_TEST }}
|
||||
TEST_PROJECT_ID: ${{ secrets.TEST_PROJECT_ID }}
|
||||
7
.gitignore
vendored
7
.gitignore
vendored
@ -1,8 +1,3 @@
|
||||
node_modules
|
||||
.DS_Store
|
||||
build
|
||||
.env
|
||||
.env.local
|
||||
.env.test
|
||||
coverage/
|
||||
*.log
|
||||
build
|
||||
@ -1,6 +0,0 @@
|
||||
node_modules/
|
||||
build/
|
||||
coverage/
|
||||
*.log
|
||||
.DS_Store
|
||||
package-lock.json
|
||||
11
.prettierrc
11
.prettierrc
@ -1,11 +0,0 @@
|
||||
{
|
||||
"semi": true,
|
||||
"trailingComma": "es5",
|
||||
"singleQuote": false,
|
||||
"printWidth": 100,
|
||||
"tabWidth": 2,
|
||||
"useTabs": false,
|
||||
"bracketSpacing": true,
|
||||
"arrowParens": "avoid",
|
||||
"endOfLine": "lf"
|
||||
}
|
||||
3
.secrets
3
.secrets
@ -1,3 +0,0 @@
|
||||
DOCKERHUB_USERNAME=DOCKERHUB_USERNAME
|
||||
DOCKERHUB_TOKEN=DOCKERHUB_TOKEN
|
||||
GITHUB_TOKEN=DOCKERHUB_TOKEN
|
||||
94
CHANGELOG.md
94
CHANGELOG.md
@ -1,97 +1,3 @@
|
||||
## [1.0.62] - 2025-06-10
|
||||
|
||||
### Fixed
|
||||
|
||||
- 🔐 **Private Token Authentication Fix**: Fixed Private-Token header authentication for GitLab API
|
||||
- Removed incorrect `Bearer ` prefix from Private-Token header in legacy authentication mode
|
||||
- Fixed authentication issues when using older GitLab instances with private tokens
|
||||
- Ensures proper API authentication for both new and legacy GitLab configurations
|
||||
- See: [PR #91](https://github.com/zereight/gitlab-mcp/pull/91), [Issue #88](https://github.com/zereight/gitlab-mcp/issues/88)
|
||||
|
||||
---
|
||||
|
||||
## [1.0.60] - 2025-06-07
|
||||
|
||||
### Added
|
||||
|
||||
- 📄 **Merge Request Enhancement**: Added support for `remove_source_branch` and `squash` options for merge requests
|
||||
- Enhanced merge request functionality with additional configuration options
|
||||
- Allows automatic source branch removal after merge
|
||||
- Supports squash commits for cleaner Git history
|
||||
- See: [PR #86](https://github.com/zereight/gitlab-mcp/pull/86)
|
||||
|
||||
### Fixed
|
||||
|
||||
- 🔧 **Issue Assignment Fix**: Fixed list issues assignee username handling
|
||||
- Corrected assignee username field in issue listing functionality
|
||||
- Improved user assignment data processing for GitLab issues
|
||||
- See: [PR #87](https://github.com/zereight/gitlab-mcp/pull/87), [Issue #74](https://github.com/zereight/gitlab-mcp/issues/74)
|
||||
|
||||
---
|
||||
|
||||
## [1.0.54] - 2025-05-31
|
||||
|
||||
### Added
|
||||
|
||||
- 🌐 **Multi-Platform Support**: Added support for multiple platforms to improve compatibility across different environments
|
||||
|
||||
- Enhanced platform detection and configuration handling
|
||||
- Improved cross-platform functionality for GitLab MCP server
|
||||
- See: [PR #71](https://github.com/zereight/gitlab-mcp/pull/71), [Issue #69](https://github.com/zereight/gitlab-mcp/issues/69)
|
||||
|
||||
- 🔐 **Custom SSL Configuration**: Added custom SSL options for enhanced security and flexibility
|
||||
- Support for custom SSL certificates and configurations
|
||||
- Improved HTTPS connection handling with custom SSL settings
|
||||
- Better support for self-signed certificates and custom CA configurations
|
||||
- See: [PR #72](https://github.com/zereight/gitlab-mcp/pull/72), [Issue #70](https://github.com/zereight/gitlab-mcp/issues/70)
|
||||
|
||||
---
|
||||
|
||||
## [1.0.48] - 2025-05-29
|
||||
|
||||
### Added
|
||||
|
||||
- 🎯 **Milestone Management Tools**: Added comprehensive milestone management functionality
|
||||
- `create_milestone`: Create new milestones for GitLab projects
|
||||
- `update_milestone`: Update existing milestone properties (title, description, dates, state)
|
||||
- `delete_milestone`: Delete milestones from projects
|
||||
- `list_milestones`: List and filter project milestones
|
||||
- `get_milestone`: Get detailed information about specific milestones
|
||||
- See: [PR #59](https://github.com/zereight/gitlab-mcp/pull/59)
|
||||
|
||||
### Fixed
|
||||
|
||||
- 🐳 **Docker Image Push Script**: Added automated Docker image push script for easier deployment
|
||||
- Simplifies the Docker image build and push process
|
||||
- See: [PR #60](https://github.com/zereight/gitlab-mcp/pull/60)
|
||||
|
||||
---
|
||||
|
||||
## [1.0.47] - 2025-05-29
|
||||
|
||||
### Added
|
||||
|
||||
- 🔄 **List Merge Requests Tool**: Added functionality to list and filter merge requests in GitLab projects
|
||||
- `list_merge_requests`: List merge requests with comprehensive filtering options
|
||||
- Supports filtering by state, scope, author, assignee, reviewer, labels, and more
|
||||
- Includes pagination support for large result sets
|
||||
- See: [PR #56](https://github.com/zereight/gitlab-mcp/pull/56)
|
||||
|
||||
### Fixed
|
||||
|
||||
- Fixed issue where GitLab users without profile pictures would cause JSON-RPC errors
|
||||
|
||||
- Changed `avatar_url` field to be nullable in GitLabUserSchema
|
||||
- This allows proper handling of users without avatars in GitLab API responses
|
||||
- See: [PR #55](https://github.com/zereight/gitlab-mcp/pull/55)
|
||||
|
||||
- Fixed issue where GitLab pipelines without illustrations would cause JSON-RPC errors
|
||||
- Changed `illustration` field to be nullable in GitLabPipelineSchema
|
||||
- This allows proper handling of pipelines without illustrations
|
||||
- See: [PR #58](https://github.com/zereight/gitlab-mcp/pull/58), [Issue #57](https://github.com/zereight/gitlab-mcp/issues/57)
|
||||
|
||||
---
|
||||
|
||||
## [1.0.46] - 2025-05-27
|
||||
|
||||
### Fixed
|
||||
|
||||
143
README.md
143
README.md
@ -26,9 +26,7 @@ When using with the Claude App, you need to set up your API key and URLs directl
|
||||
"GITLAB_PERSONAL_ACCESS_TOKEN": "your_gitlab_token",
|
||||
"GITLAB_API_URL": "your_gitlab_api_url",
|
||||
"GITLAB_READ_ONLY_MODE": "false",
|
||||
"USE_GITLAB_WIKI": "false", // use wiki api?
|
||||
"USE_MILESTONE": "false", // use milestone api?
|
||||
"USE_PIPELINE": "false" // use pipeline api?
|
||||
"USE_GITLAB_WIKI": "true"
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -36,8 +34,8 @@ When using with the Claude App, you need to set up your API key and URLs directl
|
||||
```
|
||||
|
||||
#### Docker
|
||||
- stdio
|
||||
```mcp.json
|
||||
|
||||
```json
|
||||
{
|
||||
"mcpServers": {
|
||||
"GitLab communication server": {
|
||||
@ -54,63 +52,25 @@ When using with the Claude App, you need to set up your API key and URLs directl
|
||||
"GITLAB_READ_ONLY_MODE",
|
||||
"-e",
|
||||
"USE_GITLAB_WIKI",
|
||||
"-e",
|
||||
"USE_MILESTONE",
|
||||
"-e",
|
||||
"USE_PIPELINE",
|
||||
"iwakitakuma/gitlab-mcp"
|
||||
"nkwd/gitlab-mcp"
|
||||
],
|
||||
"env": {
|
||||
"GITLAB_PERSONAL_ACCESS_TOKEN": "your_gitlab_token",
|
||||
"GITLAB_API_URL": "https://gitlab.com/api/v4", // Optional, for self-hosted GitLab
|
||||
"GITLAB_READ_ONLY_MODE": "false",
|
||||
"USE_GITLAB_WIKI": "true",
|
||||
"USE_MILESTONE": "true",
|
||||
"USE_PIPELINE": "true"
|
||||
"USE_GITLAB_WIKI": "true"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
- sse
|
||||
```shell
|
||||
docker run -i --rm \
|
||||
-e GITLAB_PERSONAL_ACCESS_TOKEN=your_gitlab_token \
|
||||
-e GITLAB_API_URL= "https://gitlab.com/api/v4"\
|
||||
-e GITLAB_READ_ONLY_MODE=true \
|
||||
-e USE_GITLAB_WIKI=true \
|
||||
-e USE_MILESTONE=true \
|
||||
-e USE_PIPELINE=true \
|
||||
-e SSE=true \
|
||||
-p 3333:3002 \
|
||||
iwakitakuma/gitlab-mcp
|
||||
```
|
||||
|
||||
```json
|
||||
{
|
||||
"mcpServers": {
|
||||
"GitLab communication server": {
|
||||
"url": "http://localhost:3333/sse"
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
#### Docker Image Push
|
||||
|
||||
```shell
|
||||
$ sh scripts/image_push.sh docker_user_name
|
||||
```
|
||||
|
||||
### Environment Variables
|
||||
|
||||
- `GITLAB_PERSONAL_ACCESS_TOKEN`: Your GitLab personal access token.
|
||||
- `GITLAB_API_URL`: Your GitLab API URL. (Default: `https://gitlab.com/api/v4`)
|
||||
- `GITLAB_READ_ONLY_MODE`: When set to 'true', restricts the server to only expose read-only operations. Useful for enhanced security or when write access is not needed. Also useful for using with Cursor and it's 40 tool limit.
|
||||
- `USE_GITLAB_WIKI`: When set to 'true', enables the wiki-related tools (list_wiki_pages, get_wiki_page, create_wiki_page, update_wiki_page, delete_wiki_page). By default, wiki features are disabled.
|
||||
- `USE_MILESTONE`: When set to 'true', enables the milestone-related tools (list_milestones, get_milestone, create_milestone, edit_milestone, delete_milestone, get_milestone_issue, get_milestone_merge_requests, promote_milestone, get_milestone_burndown_events). By default, milestone features are disabled.
|
||||
- `USE_PIPELINE`: When set to 'true', enables the pipeline-related tools (list_pipelines, get_pipeline, list_pipeline_jobs, get_pipeline_job, get_pipeline_job_output, create_pipeline, retry_pipeline, cancel_pipeline). By default, pipeline features are disabled.
|
||||
|
||||
## Tools 🛠️
|
||||
|
||||
@ -126,58 +86,43 @@ $ sh scripts/image_push.sh docker_user_name
|
||||
9. `create_branch` - Create a new branch in a GitLab project
|
||||
10. `get_merge_request` - Get details of a merge request (Either mergeRequestIid or branchName must be provided)
|
||||
11. `get_merge_request_diffs` - Get the changes/diffs of a merge request (Either mergeRequestIid or branchName must be provided)
|
||||
12. `get_branch_diffs` - Get the changes/diffs between two branches or commits in a GitLab project
|
||||
13. `update_merge_request` - Update a merge request (Either mergeRequestIid or branchName must be provided)
|
||||
14. `create_note` - Create a new note (comment) to an issue or merge request
|
||||
15. `create_merge_request_thread` - Create a new thread on a merge request
|
||||
16. `mr_discussions` - List discussion items for a merge request
|
||||
17. `update_merge_request_note` - Modify an existing merge request thread note
|
||||
18. `create_merge_request_note` - Add a new note to an existing merge request thread
|
||||
19. `update_issue_note` - Modify an existing issue thread note
|
||||
20. `create_issue_note` - Add a new note to an existing issue thread
|
||||
21. `list_issues` - List issues in a GitLab project with filtering options
|
||||
22. `get_issue` - Get details of a specific issue in a GitLab project
|
||||
23. `update_issue` - Update an issue in a GitLab project
|
||||
24. `delete_issue` - Delete an issue from a GitLab project
|
||||
25. `list_issue_links` - List all issue links for a specific issue
|
||||
26. `list_issue_discussions` - List discussions for an issue in a GitLab project
|
||||
27. `get_issue_link` - Get a specific issue link
|
||||
28. `create_issue_link` - Create an issue link between two issues
|
||||
29. `delete_issue_link` - Delete an issue link
|
||||
30. `list_namespaces` - List all namespaces available to the current user
|
||||
31. `get_namespace` - Get details of a namespace by ID or path
|
||||
32. `verify_namespace` - Verify if a namespace path exists
|
||||
33. `get_project` - Get details of a specific project
|
||||
34. `list_projects` - List projects accessible by the current user
|
||||
35. `list_labels` - List labels for a project
|
||||
36. `get_label` - Get a single label from a project
|
||||
37. `create_label` - Create a new label in a project
|
||||
38. `update_label` - Update an existing label in a project
|
||||
39. `delete_label` - Delete a label from a project
|
||||
40. `list_group_projects` - List projects in a GitLab group with filtering options
|
||||
41. `list_wiki_pages` - List wiki pages in a GitLab project
|
||||
42. `get_wiki_page` - Get details of a specific wiki page
|
||||
43. `create_wiki_page` - Create a new wiki page in a GitLab project
|
||||
44. `update_wiki_page` - Update an existing wiki page in a GitLab project
|
||||
45. `delete_wiki_page` - Delete a wiki page from a GitLab project
|
||||
46. `get_repository_tree` - Get the repository tree for a GitLab project (list files and directories)
|
||||
47. `list_pipelines` - List pipelines in a GitLab project with filtering options
|
||||
48. `get_pipeline` - Get details of a specific pipeline in a GitLab project
|
||||
49. `list_pipeline_jobs` - List all jobs in a specific pipeline
|
||||
50. `get_pipeline_job` - Get details of a GitLab pipeline job number
|
||||
51. `get_pipeline_job_output` - Get the output/trace of a GitLab pipeline job number
|
||||
52. `create_pipeline` - Create a new pipeline for a branch or tag
|
||||
53. `retry_pipeline` - Retry a failed or canceled pipeline
|
||||
54. `cancel_pipeline` - Cancel a running pipeline
|
||||
55. `list_merge_requests` - List merge requests in a GitLab project with filtering options
|
||||
56. `list_milestones` - List milestones in a GitLab project with filtering options
|
||||
57. `get_milestone` - Get details of a specific milestone
|
||||
58. `create_milestone` - Create a new milestone in a GitLab project
|
||||
59. `edit_milestone` - Edit an existing milestone in a GitLab project
|
||||
60. `delete_milestone` - Delete a milestone from a GitLab project
|
||||
61. `get_milestone_issue` - Get issues associated with a specific milestone
|
||||
62. `get_milestone_merge_requests` - Get merge requests associated with a specific milestone
|
||||
63. `promote_milestone` - Promote a milestone to the next stage
|
||||
64. `get_milestone_burndown_events` - Get burndown events for a specific milestone
|
||||
65. `get_users` - Get GitLab user details by usernames
|
||||
12. `update_merge_request` - Update a merge request (Either mergeRequestIid or branchName must be provided)
|
||||
13. `create_note` - Create a new note (comment) to an issue or merge request
|
||||
14. `create_merge_request_thread` - Create a new thread on a merge request
|
||||
15. `mr_discussions` - List discussion items for a merge request
|
||||
16. `update_merge_request_note` - Modify an existing merge request thread note
|
||||
17. `create_merge_request_note` - Add a new note to an existing merge request thread
|
||||
18. `update_issue_note` - Modify an existing issue thread note
|
||||
19. `create_issue_note` - Add a new note to an existing issue thread
|
||||
20. `list_issues` - List issues in a GitLab project with filtering options
|
||||
21. `get_issue` - Get details of a specific issue in a GitLab project
|
||||
22. `update_issue` - Update an issue in a GitLab project
|
||||
23. `delete_issue` - Delete an issue from a GitLab project
|
||||
24. `list_issue_links` - List all issue links for a specific issue
|
||||
25. `list_issue_discussions` - List discussions for an issue in a GitLab project
|
||||
26. `get_issue_link` - Get a specific issue link
|
||||
27. `create_issue_link` - Create an issue link between two issues
|
||||
28. `delete_issue_link` - Delete an issue link
|
||||
29. `list_namespaces` - List all namespaces available to the current user
|
||||
30. `get_namespace` - Get details of a namespace by ID or path
|
||||
31. `verify_namespace` - Verify if a namespace path exists
|
||||
32. `get_project` - Get details of a specific project
|
||||
33. `list_projects` - List projects accessible by the current user
|
||||
34. `list_labels` - List labels for a project
|
||||
35. `get_label` - Get a single label from a project
|
||||
36. `create_label` - Create a new label in a project
|
||||
37. `update_label` - Update an existing label in a project
|
||||
38. `delete_label` - Delete a label from a project
|
||||
39. `list_group_projects` - List projects in a GitLab group with filtering options
|
||||
40. `list_wiki_pages` - List wiki pages in a GitLab project
|
||||
41. `get_wiki_page` - Get details of a specific wiki page
|
||||
42. `create_wiki_page` - Create a new wiki page in a GitLab project
|
||||
43. `update_wiki_page` - Update an existing wiki page in a GitLab project
|
||||
44. `delete_wiki_page` - Delete a wiki page from a GitLab project
|
||||
45. `get_repository_tree` - Get the repository tree for a GitLab project (list files and directories)
|
||||
46. `list_pipelines` - List pipelines in a GitLab project with filtering options
|
||||
47. `get_pipeline` - Get details of a specific pipeline in a GitLab project
|
||||
48. `list_pipeline_jobs` - List all jobs in a specific pipeline
|
||||
49. `get_pipeline_job` - Get details of a GitLab pipeline job number
|
||||
50. `get_pipeline_job_output` - Get the output/trace of a GitLab pipeline job number
|
||||
<!-- TOOLS-END -->
|
||||
|
||||
@ -1,11 +0,0 @@
|
||||
## [1.0.62] - 2025-06-10
|
||||
|
||||
### Fixed
|
||||
|
||||
- 🔐 **Private Token Authentication Fix**: Fixed Private-Token header authentication for GitLab API
|
||||
- Removed incorrect `Bearer ` prefix from Private-Token header in legacy authentication mode
|
||||
- Fixed authentication issues when using older GitLab instances with private tokens
|
||||
- Ensures proper API authentication for both new and legacy GitLab configurations
|
||||
- See: [PR #91](https://github.com/zereight/gitlab-mcp/pull/91), [Issue #88](https://github.com/zereight/gitlab-mcp/issues/88)
|
||||
|
||||
---
|
||||
@ -1,57 +0,0 @@
|
||||
# GitHub Secrets Setup Guide
|
||||
|
||||
## 1. Navigate to GitHub Repository
|
||||
|
||||
1. Go to your `gitlab-mcp` repository on GitHub
|
||||
2. Click on the Settings tab
|
||||
3. In the left sidebar, select "Secrets and variables" → "Actions"
|
||||
|
||||
## 2. Add Secrets
|
||||
|
||||
Click the "New repository secret" button and add the following secrets:
|
||||
|
||||
### GITLAB_TOKEN_TEST
|
||||
|
||||
- **Name**: `GITLAB_TOKEN_TEST`
|
||||
- **Value**: Your GitLab Personal Access Token
|
||||
- Used for integration tests to call the real GitLab API
|
||||
|
||||
### TEST_PROJECT_ID
|
||||
|
||||
- **Name**: `TEST_PROJECT_ID`
|
||||
- **Value**: Your test project ID (e.g., `70322092`)
|
||||
- The GitLab project ID used for testing
|
||||
|
||||
### GITLAB_API_URL (Optional)
|
||||
|
||||
- **Name**: `GITLAB_API_URL`
|
||||
- **Value**: `https://gitlab.com`
|
||||
- Only set this if using a different GitLab instance (default is https://gitlab.com)
|
||||
|
||||
## 3. Verify Configuration
|
||||
|
||||
To verify your secrets are properly configured:
|
||||
|
||||
1. Create a PR or update an existing PR
|
||||
2. Check the workflow execution in the Actions tab
|
||||
3. Confirm that the "integration-test" job successfully calls the GitLab API
|
||||
|
||||
## Security Best Practices
|
||||
|
||||
- Never commit GitLab tokens directly in code
|
||||
- Grant minimal required permissions to tokens (read_api, write_repository)
|
||||
- Rotate tokens regularly
|
||||
|
||||
## Local Testing
|
||||
|
||||
To run integration tests locally:
|
||||
|
||||
```bash
|
||||
export GITLAB_TOKEN_TEST="your-token-here"
|
||||
export TEST_PROJECT_ID="70322092"
|
||||
export GITLAB_API_URL="https://gitlab.com"
|
||||
|
||||
npm run test:integration
|
||||
```
|
||||
|
||||
⚠️ **Important**: When testing locally, use environment variables and never commit tokens to the repository!
|
||||
@ -1,6 +0,0 @@
|
||||
{
|
||||
"action": "published",
|
||||
"release": {
|
||||
"tag_name": "v1.0.53"
|
||||
}
|
||||
}
|
||||
2200
package-lock.json
generated
2200
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
23
package.json
23
package.json
@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@zereight/mcp-gitlab",
|
||||
"version": "1.0.63",
|
||||
"version": "1.0.46",
|
||||
"description": "MCP server for using the GitLab API",
|
||||
"license": "MIT",
|
||||
"author": "zereight",
|
||||
@ -20,20 +20,12 @@
|
||||
"prepare": "npm run build",
|
||||
"watch": "tsc --watch",
|
||||
"deploy": "npm publish --access public",
|
||||
"generate-tools": "npx ts-node scripts/generate-tools-readme.ts",
|
||||
"changelog": "auto-changelog -p",
|
||||
"test": "node test/validate-api.js",
|
||||
"test:integration": "node test/validate-api.js",
|
||||
"lint": "eslint . --ext .ts",
|
||||
"lint:fix": "eslint . --ext .ts --fix",
|
||||
"format": "prettier --write \"**/*.{js,ts,json,md}\"",
|
||||
"format:check": "prettier --check \"**/*.{js,ts,json,md}\""
|
||||
"generate-tools": "npx ts-node scripts/generate-tools-readme.ts"
|
||||
},
|
||||
"dependencies": {
|
||||
"@modelcontextprotocol/sdk": "1.8.0",
|
||||
"@types/node-fetch": "^2.6.12",
|
||||
"express": "^5.1.0",
|
||||
"form-data": "^4.0.0",
|
||||
"@types/node-fetch": "^2.6.12",
|
||||
"http-proxy-agent": "^7.0.2",
|
||||
"https-proxy-agent": "^7.0.6",
|
||||
"node-fetch": "^3.3.2",
|
||||
@ -41,15 +33,8 @@
|
||||
"zod-to-json-schema": "^3.23.5"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@types/express": "^5.0.2",
|
||||
"@types/node": "^22.13.10",
|
||||
"@typescript-eslint/eslint-plugin": "^8.21.0",
|
||||
"@typescript-eslint/parser": "^8.21.0",
|
||||
"eslint": "^9.18.0",
|
||||
"prettier": "^3.4.2",
|
||||
"ts-node": "^10.9.2",
|
||||
"typescript": "^5.8.2",
|
||||
"zod": "^3.24.2",
|
||||
"auto-changelog": "^2.4.0"
|
||||
"zod": "^3.24.2"
|
||||
}
|
||||
}
|
||||
|
||||
5
release-notes.md
Normal file
5
release-notes.md
Normal file
@ -0,0 +1,5 @@
|
||||
### 1.0.40 (2025-05-21)
|
||||
|
||||
- Added support for listing discussions (comments/notes) on GitLab issues.
|
||||
- Example: You can now easily fetch all conversations (comments) attached to an issue via the API.
|
||||
- Related PR: [#44](https://github.com/zereight/gitlab-mcp/pull/44)
|
||||
838
schemas.ts
838
schemas.ts
File diff suppressed because it is too large
Load Diff
@ -1,38 +0,0 @@
|
||||
#!/bin/bash
|
||||
set -e
|
||||
|
||||
# Extract version from package.json
|
||||
VERSION=$(jq -r .version package.json)
|
||||
|
||||
if [ -z "$VERSION" ]; then
|
||||
echo "Could not read version from package.json."
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Check if release notes file exists
|
||||
if [ ! -f RELEASE_NOTES.md ]; then
|
||||
echo "RELEASE_NOTES.md file does not exist."
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Generate RELEASE_NOTES.md from CHANGELOG.md for the current version
|
||||
node <<'EOF'
|
||||
const fs = require('fs');
|
||||
const changelog = fs.readFileSync('CHANGELOG.md', 'utf8');
|
||||
const pkg = JSON.parse(fs.readFileSync('package.json', 'utf8'));
|
||||
const version = pkg.version;
|
||||
|
||||
const regex = new RegExp(`## \\[${version.replace(/\./g, '\\.')}\\][\\s\\S]*?(?=\\n## |\\n?$)`, 'g');
|
||||
const match = changelog.match(regex);
|
||||
|
||||
if (match && match[0]) {
|
||||
fs.writeFileSync('RELEASE_NOTES.md', match[0].trim() + '\n');
|
||||
console.log('RELEASE_NOTES.md generated for version', version);
|
||||
} else {
|
||||
console.error('No changelog entry found for version', version);
|
||||
process.exit(1);
|
||||
}
|
||||
EOF
|
||||
|
||||
# Create GitHub release using CLI
|
||||
gh release create "$VERSION" -t "Release $VERSION" -F RELEASE_NOTES.md
|
||||
@ -1,22 +1,22 @@
|
||||
import fs from "fs";
|
||||
import path from "path";
|
||||
import { fileURLToPath } from "url";
|
||||
import fs from 'fs';
|
||||
import path from 'path';
|
||||
import { fileURLToPath } from 'url';
|
||||
|
||||
const __filename = fileURLToPath(import.meta.url);
|
||||
const __dirname = path.dirname(__filename);
|
||||
|
||||
async function main() {
|
||||
const repoRoot = path.resolve(__dirname, "..");
|
||||
const indexPath = path.join(repoRoot, "index.ts");
|
||||
const readmePath = path.join(repoRoot, "README.md");
|
||||
const repoRoot = path.resolve(__dirname, '..');
|
||||
const indexPath = path.join(repoRoot, 'index.ts');
|
||||
const readmePath = path.join(repoRoot, 'README.md');
|
||||
|
||||
// 1. Read index.ts
|
||||
const code = fs.readFileSync(indexPath, "utf-8");
|
||||
const code = fs.readFileSync(indexPath, 'utf-8');
|
||||
|
||||
// 2. Extract allTools array block
|
||||
const match = code.match(/const allTools = \[([\s\S]*?)\];/);
|
||||
if (!match) {
|
||||
console.error("Unable to locate allTools array in index.ts");
|
||||
console.error('Unable to locate allTools array in index.ts');
|
||||
process.exit(1);
|
||||
}
|
||||
const toolsBlock = match[1];
|
||||
@ -33,21 +33,21 @@ async function main() {
|
||||
const lines = tools.map((tool, index) => {
|
||||
return `${index + 1}. \`${tool.name}\` - ${tool.description}`;
|
||||
});
|
||||
const markdown = lines.join("\n");
|
||||
const markdown = lines.join('\n');
|
||||
|
||||
// 5. Read README.md and replace between markers
|
||||
const readme = fs.readFileSync(readmePath, "utf-8");
|
||||
const readme = fs.readFileSync(readmePath, 'utf-8');
|
||||
const updated = readme.replace(
|
||||
/<!-- TOOLS-START -->([\s\S]*?)<!-- TOOLS-END -->/,
|
||||
`<!-- TOOLS-START -->\n${markdown}\n<!-- TOOLS-END -->`
|
||||
);
|
||||
|
||||
// 6. Write back
|
||||
fs.writeFileSync(readmePath, updated, "utf-8");
|
||||
console.log("README.md tools section updated.");
|
||||
fs.writeFileSync(readmePath, updated, 'utf-8');
|
||||
console.log('README.md tools section updated.');
|
||||
}
|
||||
|
||||
main().catch(err => {
|
||||
console.error(err);
|
||||
process.exit(1);
|
||||
});
|
||||
});
|
||||
@ -1,18 +0,0 @@
|
||||
#!/bin/bash
|
||||
|
||||
if [ -z "$1" ]; then
|
||||
echo "Error: docker user name required."
|
||||
exit 1
|
||||
fi
|
||||
|
||||
DOCKER_USER=$1
|
||||
IMAGE_NAME=gitlab-mcp
|
||||
IMAGE_VERSION=$(jq -r '.version' package.json)
|
||||
|
||||
echo "${DOCKER_USER}/${IMAGE_NAME}:${IMAGE_VERSION}"
|
||||
|
||||
docker buildx build --platform linux/arm64,linux/amd64 \
|
||||
-t "${DOCKER_USER}/${IMAGE_NAME}:latest" \
|
||||
-t "${DOCKER_USER}/${IMAGE_NAME}:${IMAGE_VERSION}" \
|
||||
--push \
|
||||
.
|
||||
@ -1,56 +0,0 @@
|
||||
#!/bin/bash
|
||||
|
||||
# PR Validation Script
|
||||
# This script runs all necessary checks before merging a PR
|
||||
|
||||
set -e
|
||||
|
||||
echo "🔍 Starting PR validation..."
|
||||
|
||||
# Check if Node.js is installed
|
||||
if ! command -v node &> /dev/null; then
|
||||
echo "❌ Node.js is not installed"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
echo "📦 Installing dependencies..."
|
||||
npm ci
|
||||
|
||||
echo "🔨 Building project..."
|
||||
npm run build
|
||||
|
||||
echo "🧪 Running unit tests..."
|
||||
npm run test:unit
|
||||
|
||||
echo "✨ Checking code formatting..."
|
||||
npm run format:check || {
|
||||
echo "⚠️ Code formatting issues found. Run 'npm run format' to fix."
|
||||
exit 1
|
||||
}
|
||||
|
||||
echo "🔍 Running linter..."
|
||||
npm run lint || {
|
||||
echo "⚠️ Linting issues found. Run 'npm run lint:fix' to fix."
|
||||
exit 1
|
||||
}
|
||||
|
||||
echo "📊 Running tests with coverage..."
|
||||
npm run test:coverage
|
||||
|
||||
# Check if integration tests should run
|
||||
if [ -n "$GITLAB_TOKEN" ] && [ -n "$TEST_PROJECT_ID" ]; then
|
||||
echo "🌐 Running integration tests..."
|
||||
npm run test:integration
|
||||
else
|
||||
echo "⚠️ Skipping integration tests (no credentials provided)"
|
||||
fi
|
||||
|
||||
echo "🐳 Testing Docker build..."
|
||||
if command -v docker &> /dev/null; then
|
||||
docker build -t mcp-gitlab-test .
|
||||
echo "✅ Docker build successful"
|
||||
else
|
||||
echo "⚠️ Docker not available, skipping Docker build test"
|
||||
fi
|
||||
|
||||
echo "✅ All PR validation checks passed!"
|
||||
@ -33,7 +33,9 @@ async function testCreateIssueNote() {
|
||||
|
||||
if (!response.ok) {
|
||||
const errorBody = await response.text();
|
||||
throw new Error(`GitLab API error: ${response.status} ${response.statusText}\n${errorBody}`);
|
||||
throw new Error(
|
||||
`GitLab API error: ${response.status} ${response.statusText}\n${errorBody}`
|
||||
);
|
||||
}
|
||||
|
||||
const data = await response.json();
|
||||
|
||||
@ -1,154 +0,0 @@
|
||||
#!/usr/bin/env node
|
||||
|
||||
// Simple API validation script for PR testing
|
||||
import fetch from "node-fetch";
|
||||
|
||||
const GITLAB_API_URL = process.env.GITLAB_API_URL || "https://gitlab.com";
|
||||
const GITLAB_TOKEN = process.env.GITLAB_TOKEN_TEST || process.env.GITLAB_TOKEN;
|
||||
const TEST_PROJECT_ID = process.env.TEST_PROJECT_ID;
|
||||
|
||||
async function validateGitLabAPI() {
|
||||
console.log("🔍 Validating GitLab API connection...\n");
|
||||
|
||||
if (!GITLAB_TOKEN) {
|
||||
console.warn("⚠️ No GitLab token provided. Skipping API validation.");
|
||||
console.log("Set GITLAB_TOKEN_TEST or GITLAB_TOKEN to enable API validation.\n");
|
||||
return true;
|
||||
}
|
||||
|
||||
if (!TEST_PROJECT_ID) {
|
||||
console.warn("⚠️ No test project ID provided. Skipping API validation.");
|
||||
console.log("Set TEST_PROJECT_ID to enable API validation.\n");
|
||||
return true;
|
||||
}
|
||||
|
||||
const tests = [
|
||||
{
|
||||
name: "Fetch project info",
|
||||
url: `${GITLAB_API_URL}/api/v4/projects/${encodeURIComponent(TEST_PROJECT_ID)}`,
|
||||
validate: data => data.id && data.name,
|
||||
},
|
||||
{
|
||||
name: "List issues",
|
||||
url: `${GITLAB_API_URL}/api/v4/projects/${encodeURIComponent(TEST_PROJECT_ID)}/issues?per_page=1`,
|
||||
validate: data => Array.isArray(data),
|
||||
},
|
||||
{
|
||||
name: "List merge requests",
|
||||
url: `${GITLAB_API_URL}/api/v4/projects/${encodeURIComponent(TEST_PROJECT_ID)}/merge_requests?per_page=1`,
|
||||
validate: data => Array.isArray(data),
|
||||
},
|
||||
{
|
||||
name: "List branches",
|
||||
url: `${GITLAB_API_URL}/api/v4/projects/${encodeURIComponent(TEST_PROJECT_ID)}/repository/branches?per_page=1`,
|
||||
validate: data => Array.isArray(data),
|
||||
},
|
||||
{
|
||||
name: "List pipelines",
|
||||
url: `${GITLAB_API_URL}/api/v4/projects/${encodeURIComponent(TEST_PROJECT_ID)}/pipelines?per_page=5`,
|
||||
validate: data => Array.isArray(data),
|
||||
},
|
||||
];
|
||||
|
||||
let allPassed = true;
|
||||
let firstPipelineId = null;
|
||||
|
||||
for (const test of tests) {
|
||||
try {
|
||||
console.log(`Testing: ${test.name}`);
|
||||
const response = await fetch(test.url, {
|
||||
headers: {
|
||||
Authorization: `Bearer ${GITLAB_TOKEN}`,
|
||||
Accept: "application/json",
|
||||
},
|
||||
});
|
||||
|
||||
if (!response.ok) {
|
||||
throw new Error(`HTTP ${response.status}: ${response.statusText}`);
|
||||
}
|
||||
|
||||
const data = await response.json();
|
||||
|
||||
if (test.validate(data)) {
|
||||
console.log(`✅ ${test.name} - PASSED\n`);
|
||||
|
||||
// If we found pipelines, save the first one for additional testing
|
||||
if (test.name === "List pipelines" && data.length > 0) {
|
||||
firstPipelineId = data[0].id;
|
||||
}
|
||||
} else {
|
||||
console.log(`❌ ${test.name} - FAILED (invalid response format)\n`);
|
||||
allPassed = false;
|
||||
}
|
||||
} catch (error) {
|
||||
console.log(`❌ ${test.name} - FAILED`);
|
||||
console.log(` Error: ${error.message}\n`);
|
||||
allPassed = false;
|
||||
}
|
||||
}
|
||||
|
||||
// Test pipeline-specific endpoints if we have a pipeline ID
|
||||
if (firstPipelineId) {
|
||||
console.log(`Found pipeline #${firstPipelineId}, testing pipeline-specific endpoints...\n`);
|
||||
|
||||
const pipelineTests = [
|
||||
{
|
||||
name: `Get pipeline #${firstPipelineId} details`,
|
||||
url: `${GITLAB_API_URL}/api/v4/projects/${encodeURIComponent(TEST_PROJECT_ID)}/pipelines/${firstPipelineId}`,
|
||||
validate: data => data.id === firstPipelineId && data.status,
|
||||
},
|
||||
{
|
||||
name: `List pipeline #${firstPipelineId} jobs`,
|
||||
url: `${GITLAB_API_URL}/api/v4/projects/${encodeURIComponent(TEST_PROJECT_ID)}/pipelines/${firstPipelineId}/jobs`,
|
||||
validate: data => Array.isArray(data),
|
||||
},
|
||||
];
|
||||
|
||||
for (const test of pipelineTests) {
|
||||
try {
|
||||
console.log(`Testing: ${test.name}`);
|
||||
const response = await fetch(test.url, {
|
||||
headers: {
|
||||
Authorization: `Bearer ${GITLAB_TOKEN}`,
|
||||
Accept: "application/json",
|
||||
},
|
||||
});
|
||||
|
||||
if (!response.ok) {
|
||||
throw new Error(`HTTP ${response.status}: ${response.statusText}`);
|
||||
}
|
||||
|
||||
const data = await response.json();
|
||||
|
||||
if (test.validate(data)) {
|
||||
console.log(`✅ ${test.name} - PASSED\n`);
|
||||
} else {
|
||||
console.log(`❌ ${test.name} - FAILED (invalid response format)\n`);
|
||||
allPassed = false;
|
||||
}
|
||||
} catch (error) {
|
||||
console.log(`❌ ${test.name} - FAILED`);
|
||||
console.log(` Error: ${error.message}\n`);
|
||||
allPassed = false;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if (allPassed) {
|
||||
console.log("✅ All API validation tests passed!");
|
||||
} else {
|
||||
console.log("❌ Some API validation tests failed!");
|
||||
}
|
||||
|
||||
return allPassed;
|
||||
}
|
||||
|
||||
// Run validation
|
||||
validateGitLabAPI()
|
||||
.then(success => process.exit(success ? 0 : 1))
|
||||
.catch(error => {
|
||||
console.error("Unexpected error:", error);
|
||||
process.exit(1);
|
||||
});
|
||||
|
||||
export { validateGitLabAPI };
|
||||
Reference in New Issue
Block a user