Skip to content

Commit fe69758

Browse files
committed
docs: Update CI/CD workflows and add security configuration docs
- Improved CI/CD workflows with better structure - Fixed CHANGELOG dates (2025 → 2026) - Added documentation for DBEAVER_READ_ONLY and DBEAVER_DISABLED_TOOLS - Added read-only configuration example - Updated package-lock.json
1 parent 4309d0c commit fe69758

5 files changed

Lines changed: 6754 additions & 6775 deletions

File tree

.github/workflows/ci.yml

Lines changed: 12 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,10 @@ jobs:
1515
node-version: [18.x, 20.x, 22.x]
1616

1717
steps:
18-
- uses: actions/checkout@v4
18+
- name: Checkout code
19+
uses: actions/checkout@v4
1920

20-
- name: Use Node.js ${{ matrix.node-version }}
21+
- name: Setup Node.js ${{ matrix.node-version }}
2122
uses: actions/setup-node@v4
2223
with:
2324
node-version: ${{ matrix.node-version }}
@@ -26,32 +27,27 @@ jobs:
2627
- name: Install dependencies
2728
run: npm ci
2829

29-
- name: Lint
30+
- name: Run linter
3031
run: npm run lint
3132

3233
- name: Build
3334
run: npm run build
3435

35-
- name: Test
36+
- name: Run tests
3637
run: npm test
3738

38-
publish-check:
39-
runs-on: ubuntu-latest
40-
needs: build
41-
if: github.ref == 'refs/heads/main'
39+
- name: Check for vulnerabilities
40+
run: npm audit --audit-level=high
41+
continue-on-error: true
4242

43+
typecheck:
44+
runs-on: ubuntu-latest
4345
steps:
4446
- uses: actions/checkout@v4
45-
4647
- uses: actions/setup-node@v4
4748
with:
4849
node-version: '20.x'
4950
cache: 'npm'
50-
5151
- run: npm ci
52-
- run: npm run build
53-
54-
- name: Check package version
55-
run: |
56-
CURRENT_VERSION=$(node -p "require('./package.json').version")
57-
echo "Current version: $CURRENT_VERSION"
52+
- name: Type check
53+
run: npm run typecheck

.github/workflows/release.yml

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,31 +6,43 @@ on:
66
- 'v*'
77

88
jobs:
9-
publish:
9+
release:
1010
runs-on: ubuntu-latest
1111
permissions:
1212
contents: write
1313
id-token: write
1414

1515
steps:
16-
- uses: actions/checkout@v4
16+
- name: Checkout code
17+
uses: actions/checkout@v4
1718

18-
- uses: actions/setup-node@v4
19+
- name: Setup Node.js
20+
uses: actions/setup-node@v4
1921
with:
2022
node-version: '20.x'
2123
registry-url: 'https://registry.npmjs.org'
2224
cache: 'npm'
2325

24-
- run: npm ci
25-
- run: npm run build
26-
- run: npm test
26+
- name: Install dependencies
27+
run: npm ci
28+
29+
- name: Run linter
30+
run: npm run lint
31+
32+
- name: Build
33+
run: npm run build
34+
35+
- name: Run tests
36+
run: npm test
2737

2838
- name: Publish to npm
2939
run: npm publish --provenance --access public
3040
env:
3141
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
3242

3343
- name: Create GitHub Release
34-
uses: softprops/action-gh-release@v1
44+
uses: softprops/action-gh-release@v2
3545
with:
3646
generate_release_notes: true
47+
files: |
48+
dist/**

CHANGELOG.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ All notable changes to this project will be documented in this file.
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

8-
## [1.2.4] - 2025-01-14
8+
## [1.2.4] - 2026-01-15
99

1010
### Added
1111
- Native MySQL/MariaDB support via `mysql2` library
@@ -26,7 +26,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
2626
- Security vulnerabilities in dependencies
2727
- `@types/mssql` moved to devDependencies
2828

29-
## [1.2.3] - 2025-01-07
29+
## [1.2.3] - 2026-01-07
3030

3131
### Added
3232
- Native MSSQL/SQL Server support via `mssql` library

docs-site/docs/getting-started/configuration.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,21 @@ To use DBeaver MCP Server with Claude Desktop, add the following to your configu
3939
}
4040
```
4141

42+
### Read-Only Configuration
43+
```json
44+
{
45+
"mcpServers": {
46+
"dbeaver": {
47+
"command": "dbeaver-mcp-server",
48+
"env": {
49+
"DBEAVER_READ_ONLY": "true",
50+
"DBEAVER_TIMEOUT": "30000"
51+
}
52+
}
53+
}
54+
}
55+
```
56+
4257
## Environment Variables
4358

4459
### Core Variables
@@ -47,6 +62,10 @@ To use DBeaver MCP Server with Claude Desktop, add the following to your configu
4762
- `DBEAVER_TIMEOUT`: Set the query timeout in milliseconds (default: 30000)
4863
- `DBEAVER_DEBUG`: Set to `true` to enable debug logging
4964

65+
### Security Variables
66+
- `DBEAVER_READ_ONLY`: Set to `true` to disable all write operations (blocks `write_query`, `create_table`, `alter_table`, `drop_table`)
67+
- `DBEAVER_DISABLED_TOOLS`: Comma-separated list of tool names to disable (e.g., `drop_table,alter_table`)
68+
5069
### Platform-Specific Paths
5170
```bash
5271
# macOS
@@ -70,6 +89,14 @@ dbeaver-mcp-server
7089
export DBEAVER_DEBUG=false
7190
export DBEAVER_TIMEOUT=120000
7291
dbeaver-mcp-server
92+
93+
# Read-only mode (disable all write operations)
94+
export DBEAVER_READ_ONLY=true
95+
dbeaver-mcp-server
96+
97+
# Disable specific tools
98+
export DBEAVER_DISABLED_TOOLS="drop_table,alter_table"
99+
dbeaver-mcp-server
73100
```
74101

75102
## Cursor IDE Integration

0 commit comments

Comments
 (0)