Skip to content

Commit 90efc76

Browse files
committed
Merge branch 'master' into copilot/migrate-aliyun-database-resources
2 parents 6fbe8d7 + 2edb344 commit 90efc76

38 files changed

+324
-162
lines changed

.gitattributes

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* text=auto eol=lf

.github/ISSUE_TEMPLATE/CONTRIBUTION.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
# Contributing to ServerlessInsight
22

33
## Introduction
4+
45
First off, thank you for considering contributing to ServerlessInsight! It's people like you that make this project great.
56

67
## How to Contribute
8+
79
1. Fork the repository.
810
2. Create a new branch (`git checkout -b [feat|doc|fix|refactor]/your-branch`).
911
3. Make your changes.
@@ -12,27 +14,33 @@ First off, thank you for considering contributing to ServerlessInsight! It's peo
1214
6. Create a new Pull Request.
1315

1416
## Code of Conduct
17+
1518
Please read our [Code of Conduct](CODE_OF_CONDUCT.md) to understand the expectations for behavior when contributing to this project.
1619

1720
## Reporting Issues
21+
1822
If you find a bug, please create an issue using the [bug report template](.github/ISSUE_TEMPLATE/bug_report.md). Provide as much detail as possible to help us understand and resolve the issue.
1923

2024
## Submitting Pull Requests
25+
2126
- Ensure your code follows the project's coding standards.
2227
- Write clear, concise commit messages.
2328
- Include tests for any new functionality.
2429
- Ensure all tests pass before submitting your pull request.
2530

2631
## Coding Standards
32+
2733
- Follow the typescript style Guide and pass all syle checkes
2834
- Use [Prettier](https://prettier.io/) for code formatting.
2935
- Ensure your code passes linting (`npm run lint:check`).
3036

3137
## Running Tests
38+
3239
- Run tests with `npm test`.
3340
- Ensure all tests pass before submitting your pull request.
3441

3542
## Additional Resources
43+
3644
- [Project Documentation](https://serverlessinsight.geekfun.club/)
3745
- [GitHub Repository](https://github.com/geek-fun/serverlessinsight)
3846
- [GEEKFUN Community](https://www.geekfun.club/)

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,22 @@
11
---
22
name: Bug report
33
about: Create a report to help us improve
4-
title: "[BUG] "
4+
title: '[BUG] '
55
labels: bug
66
assignees: ''
7-
87
---
98

109
**Describe the bug**
1110
A clear and concise description of what the bug is.
1211

1312
**Desktop (please complete the following information):**
14-
- OS: [e.g. macOS]
15-
- Version [e.g. 0.1]
16-
13+
14+
- OS: [e.g. macOS]
15+
- Version [e.g. 0.1]
16+
1717
**Reproduce Steps**
1818
Steps to reproduce the behavior:
19+
1920
1. Go to '...'
2021
2. Click on '....'
2122
3. Scroll down to '....'

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
---
22
name: Feature request
33
about: Suggest an idea for this project
4-
title: "[FEATURE] "
4+
title: '[FEATURE] '
55
labels: feature
66
assignees: ''
7-
87
---
98

109
**Is your feature request related to a problem? Please describe.**
@@ -17,4 +16,4 @@ A clear and concise description of what you want to happen.
1716
A clear and concise description of any alternative solutions or features you've considered.
1817

1918
**Additional context**
20-
Add any other context or screenshots about the feature request here.
19+
Add any other context or screenshots about the feature request here.

.github/workflows/node.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,16 @@ name: Node.js CI
22

33
on:
44
push:
5-
branches: [master]
5+
branches: [master]
66
pull_request:
7-
branches: [master]
7+
branches: [master]
88

99
jobs:
1010
build:
1111
strategy:
1212
fail-fast: false
1313
matrix:
14-
os: [ubuntu-latest]
14+
os: [ubuntu-latest, windows-latest, macos-latest]
1515
node-version: [24.x]
1616

1717
runs-on: ${{ matrix.os }}
@@ -20,7 +20,6 @@ jobs:
2020
steps:
2121
- name: Github checkout
2222
uses: actions/checkout@v4
23-
if: matrix.os == 'ubuntu-latest'
2423
- name: Use Node.js ${{ matrix.node-version }}
2524
uses: actions/setup-node@v3
2625
with:
@@ -32,6 +31,7 @@ jobs:
3231
- run: npm run build
3332
- run: npm run test:ci
3433
- name: Upload coverage reports to Codecov
34+
if: matrix.os == 'ubuntu-latest'
3535
uses: codecov/codecov-action@v4
3636
with:
3737
token: ${{ secrets.CODECOV_TOKEN }}

.github/workflows/release-si-bootstrap-sdk.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ jobs:
2121
- name: Checkout repository
2222
uses: actions/checkout@v4
2323
with:
24-
fetch-depth: 0 # Fetch all history to check tags
24+
fetch-depth: 0 # Fetch all history to check tags
2525

2626
- name: Get package version and check for changes
2727
id: version_check
@@ -59,8 +59,8 @@ jobs:
5959
env:
6060
ALIYUN_ACCESS_KEY_ID: ${{ secrets.ALIYUN_ACCESS_KEY_ID }}
6161
ALIYUN_ACCESS_KEY_SECRET: ${{ secrets.ALIYUN_ACCESS_KEY_SECRET }}
62-
ALIYUN_REGIONS: "cn-beijing,cn-hangzhou,cn-chengdu,ap-southeast-1"
63-
ALIYUN_COMPATIBLE_RUNTIMES: "nodejs20,nodejs18,nodejs16"
62+
ALIYUN_REGIONS: 'cn-beijing,cn-hangzhou,cn-chengdu,ap-southeast-1'
63+
ALIYUN_COMPATIBLE_RUNTIMES: 'nodejs20,nodejs18,nodejs16'
6464
run: ./scripts/publish-to-regions.sh
6565

6666
- name: Create GitHub Release

.github/workflows/release.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,12 +24,12 @@ jobs:
2424
uses: actions/checkout@v4
2525
if: matrix.os == 'ubuntu-latest'
2626
with:
27-
fetch-depth: 0 # Fetch all history including tags for version checking
27+
fetch-depth: 0 # Fetch all history including tags for version checking
2828
- name: Use Node.js ${{ matrix.node-version }}
2929
uses: actions/setup-node@v4
3030
with:
3131
node-version: ${{ matrix.node-version }}
32-
registry-url: "https://registry.npmjs.org"
32+
registry-url: 'https://registry.npmjs.org'
3333
- name: Install dependencies
3434
run: npm ci
3535
- run: npm run lint:check

README.md

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -47,14 +47,14 @@ Whether you're building on AWS, Alibaba Cloud, Huawei Cloud, or other providers,
4747

4848
ServerlessInsight supports the following cloud providers:
4949

50-
| Provider | Functions | API Gateway | Storage | Databases | Status |
51-
|----------|-----------|-------------|---------|-----------|--------|
52-
| **Alibaba Cloud** | ✅ FC3 | ✅ API Gateway | ✅ OSS | ✅ RDS, OTS, ESS | Stable |
53-
| **Huawei Cloud** | ✅ FunctionGraph | 🚧 Coming Soon | 🚧 Coming Soon | 🚧 Coming Soon | Beta |
54-
| **AWS** | 🔜 Planned | 🔜 Planned | 🔜 Planned | 🔜 Planned | Planned |
55-
| **Azure** | 🔜 Planned | 🔜 Planned | 🔜 Planned | 🔜 Planned | Planned |
56-
| **Google Cloud** | 🔜 Planned | 🔜 Planned | 🔜 Planned | 🔜 Planned | Planned |
57-
| **Tencent Cloud** | 🔜 Planned | 🔜 Planned | 🔜 Planned | 🔜 Planned | Planned |
50+
| Provider | Functions | API Gateway | Storage | Databases | Status |
51+
| ----------------- | ---------------- | -------------- | -------------- | ---------------- | ------- |
52+
| **Alibaba Cloud** | ✅ FC3 | ✅ API Gateway | ✅ OSS | ✅ RDS, OTS, ESS | Stable |
53+
| **Huawei Cloud** | ✅ FunctionGraph | 🚧 Coming Soon | 🚧 Coming Soon | 🚧 Coming Soon | Beta |
54+
| **AWS** | 🔜 Planned | 🔜 Planned | 🔜 Planned | 🔜 Planned | Planned |
55+
| **Azure** | 🔜 Planned | 🔜 Planned | 🔜 Planned | 🔜 Planned | Planned |
56+
| **Google Cloud** | 🔜 Planned | 🔜 Planned | 🔜 Planned | 🔜 Planned | Planned |
57+
| **Tencent Cloud** | 🔜 Planned | 🔜 Planned | 🔜 Planned | 🔜 Planned | Planned |
5858

5959
---
6060

@@ -188,7 +188,6 @@ curl http://localhost:4567/si_buckets/<bucket_key>/subdir/
188188

189189
The bucket handler serves files from the directory specified in your bucket's `website.code` configuration.
190190

191-
192191
### Architecture
193192

194193
ServerlessInsight follows a **functional client architecture** that cleanly separates cloud provider SDKs from business logic:
@@ -239,21 +238,20 @@ await client.fc3.createFunction(config, codeBase64);
239238
```
240239

241240
This architecture enables:
241+
242242
- **Better Testing**: Mock client operations instead of SDKs
243243
- **Maintainability**: Provider changes isolated to client layer
244244
- **Type Safety**: Strong typing throughout the stack
245245
- **Code Reuse**: Shared client operations across resources
246246

247-
248-
249-
250247
---
251248

252249
## 📘 Documentation
253250

254251
For comprehensive documentation, visit [serverlessinsight.geekfun.club](https://serverlessinsight.geekfun.club)
255252

256253
Additional resources:
254+
257255
- [Quick Start Guide](https://serverlessinsight.geekfun.club)
258256
- [Configuration Reference](https://serverlessinsight.geekfun.club)
259257
- [API Documentation](https://serverlessinsight.geekfun.club)

README.zh-CN.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -47,14 +47,14 @@ ServerlessInsight 是一个强大的 Serverless 框架,用于跨多个云服
4747

4848
ServerlessInsight 支持以下云服务商:
4949

50-
| 云服务商 | 函数 | API 网关 | 存储 | 数据库 | 状态 |
51-
|----------|------|----------|------|--------|------|
52-
| **阿里云** | ✅ FC3 | ✅ API 网关 | ✅ OSS | ✅ RDS, OTS, ESS | 稳定 |
53-
| **华为云** | ✅ FunctionGraph | 🚧 即将推出 | 🚧 即将推出 | 🚧 即将推出 | 测试版 |
54-
| **AWS** | 🔜 计划中 | 🔜 计划中 | 🔜 计划中 | 🔜 计划中 | 计划中 |
55-
| **Azure** | 🔜 计划中 | 🔜 计划中 | 🔜 计划中 | 🔜 计划中 | 计划中 |
56-
| **Google Cloud** | 🔜 计划中 | 🔜 计划中 | 🔜 计划中 | 🔜 计划中 | 计划中 |
57-
| **腾讯云** | 🔜 计划中 | 🔜 计划中 | 🔜 计划中 | 🔜 计划中 | 计划中 |
50+
| 云服务商 | 函数 | API 网关 | 存储 | 数据库 | 状态 |
51+
| ---------------- | ---------------- | ----------- | ----------- | ---------------- | ------ |
52+
| **阿里云** | ✅ FC3 | ✅ API 网关 | ✅ OSS | ✅ RDS, OTS, ESS | 稳定 |
53+
| **华为云** | ✅ FunctionGraph | 🚧 即将推出 | 🚧 即将推出 | 🚧 即将推出 | 测试版 |
54+
| **AWS** | 🔜 计划中 | 🔜 计划中 | 🔜 计划中 | 🔜 计划中 | 计划中 |
55+
| **Azure** | 🔜 计划中 | 🔜 计划中 | 🔜 计划中 | 🔜 计划中 | 计划中 |
56+
| **Google Cloud** | 🔜 计划中 | 🔜 计划中 | 🔜 计划中 | 🔜 计划中 | 计划中 |
57+
| **腾讯云** | 🔜 计划中 | 🔜 计划中 | 🔜 计划中 | 🔜 计划中 | 计划中 |
5858

5959
---
6060

@@ -178,6 +178,7 @@ npm run lint:check
178178
完整文档请访问 [serverlessinsight.geekfun.club](https://serverlessinsight.geekfun.club)
179179

180180
其他资源:
181+
181182
- [快速开始指南](https://serverlessinsight.geekfun.club)
182183
- [配置参考](https://serverlessinsight.geekfun.club)
183184
- [API 文档](https://serverlessinsight.geekfun.club)

docs/index.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,13 @@ a CI/CD service considerations:
33
- Zero downtime
44

55
- health check
6+
- **Startup probes**
67

7-
- **Startup probes**
8+
- **Readiness probes**
89

9-
- **Readiness probes**
10+
- **Liveness probes**
1011

11-
- **Liveness probes**
12-
13-
> https://www.fairwinds.com/blog/a-guide-to-understanding-kubernetes-liveness-probes-best-practices
12+
> https://www.fairwinds.com/blog/a-guide-to-understanding-kubernetes-liveness-probes-best-practices
1413
1514
- Blue/green deployment
1615

0 commit comments

Comments
 (0)