Skip to content

Commit ea2d67a

Browse files
jianxuanbingjianxuanbing
committed
📝 docs(README): 更新 NuGet 包信息展示
- 修改 NuGet 包信息表格，增加预览版本和下载数列 - 更新 Bing.Elasticsearch 包的徽章为可点击的链接 - 添加 Bing.Extensions.Elasticsearch 包的信息
1 parent a004673 commit ea2d67a

File tree

10 files changed

+291
-3
lines changed

10 files changed

+291
-3
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
name: 错误报告
3+
about: 创建一个报告来帮助我们改进
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
---
8+
9+
**描述这个 Bug**
10+
11+
请简要清晰地描述这个错误是什么。
12+
13+
**复现步骤**
14+
15+
复现该问题的步骤如下：
16+
1. ...
17+
2. ...
18+
3. ....
19+
20+
**期望的行为**
21+
22+
请简要描述你原本预期会发生什么。
23+
24+
**截图**
25+
26+
如有需要，请添加截图来帮助说明你的问题。
27+
28+
**运行时版本**
29+
30+
- dotnet 版本：
31+
- `Bing.Utils` 版本：
32+
33+
**其他上下文信息**
34+
35+
请添加与该问题有关的其他上下文信息。

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
name: 功能请求
3+
about: 为该项目提出一个改进建议
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
---
8+
9+
**该功能请求是否与某个问题相关？请描述**
10+
11+
请简要清晰地描述这个问题。例如：每当我遇到 [...] 的时候，我总是感到困扰。
12+
13+
**你期望的解决方案**
14+
15+
请简要清晰地描述你希望实现什么样的功能或行为。
16+
17+
**你考虑过的替代方案**
18+
19+
请简要描述你曾考虑过的其他解决方案或替代功能。
20+
21+
**其他补充信息**
22+
23+
请在此添加与功能请求相关的其他上下文信息或截图。

‎.github/workflows/docfx.yml‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
name: docfx
2+
on:
3+
push:
4+
branches:
5+
- "main"
6+
- "master"
7+
- "dev"
8+
9+
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
10+
permissions:
11+
actions: read
12+
pages: write
13+
id-token: write
14+
15+
# Allow only one concurrent deployment, skipping runs queued between the run in progress and the latest queued.
16+
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
17+
concurrency:
18+
group: "pages"
19+
cancel-in-progress: false
20+
21+
jobs:
22+
build:
23+
name: "publish docs"
24+
environment:
25+
name: github-pages
26+
url: ${{ steps.deployment.outputs.page_url }}
27+
runs-on: ubuntu-latest
28+
steps:
29+
# Check out the branch that triggered this workflow to the 'source' subdirectory
30+
- name: Checkout Code
31+
uses: actions/checkout@v4
32+
- name: Setup .NET SDK
33+
uses: actions/setup-dotnet@v4
34+
with:
35+
dotnet-version: |
36+
6.0.x
37+
7.0.x
38+
8.0.x
39+
9.0.x
40+
- name: install dotnet tools
41+
run: |
42+
dotnet tool install -g dotnet-execute
43+
dotnet tool install -g docfx
44+
# Run a build
45+
- name: Build docs
46+
run: |
47+
dotnet-exec info
48+
dotnet build
49+
docfx ./docs/docfx.json
50+
- name: Upload artifact
51+
uses: actions/upload-pages-artifact@v3
52+
with:
53+
path: 'docs/_site'
54+
- name: Deploy to GitHub Pages
55+
id: deployment
56+
uses: actions/deploy-pages@v4
57+
# - name: cloudflare-pages
58+
# uses: cloudflare/wrangler-action@v3
59+
# with:
60+
# accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
61+
# apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
62+
# command: pages deploy docs/_site --project-name=bing-utils

‎README.md‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,10 @@
44
Bing.Elasticsearch是Bing应用框架的Elasticsearch操作类库。
55

66
## Nuget Packages
7-
|Nuget|版本号|说明|
8-
|---|---|---|
9-
|Bing.Elasticsearch|[![NuGet Badge](https://buildstats.info/nuget/Bing.Elasticsearch?includePreReleases=true)](https://www.nuget.org/packages/Bing.Elasticsearch)|
7+
|包名称|稳定版本|预览版本|下载数|
8+
|----|----|----|----|
9+
|[Bing.Elasticsearch](https://www.nuget.org/packages/Bing.Elasticsearch/)|[![Bing.Elasticsearch](https://img.shields.io/nuget/v/Bing.Elasticsearch.svg)](https://www.nuget.org/packages/Bing.Elasticsearch/)|[![Bing.Elasticsearch](https://img.shields.io/nuget/vpre/Bing.Elasticsearch.svg)](https://www.nuget.org/packages/Bing.Elasticsearch/)|[![Bing.Elasticsearch](https://img.shields.io/nuget/dt/Bing.Elasticsearch.svg)](https://www.nuget.org/packages/Bing.Elasticsearch/)|
10+
|[Bing.Extensions.Elasticsearch](https://www.nuget.org/packages/Bing.Extensions.Elasticsearch/)|[![Bing.Extensions.Elasticsearch](https://img.shields.io/nuget/v/Bing.Extensions.Elasticsearch.svg)](https://www.nuget.org/packages/Bing.Extensions.Elasticsearch/)|[![Bing.Extensions.Elasticsearch](https://img.shields.io/nuget/vpre/Bing.Extensions.Elasticsearch.svg)](https://www.nuget.org/packages/Bing.Extensions.Elasticsearch/)|[![Bing.Extensions.Elasticsearch](https://img.shields.io/nuget/dt/Bing.Extensions.Elasticsearch.svg)](https://www.nuget.org/packages/Bing.Extensions.Elasticsearch/)|
1011

1112
## 实现功能
1213

‎docs/ReleaseNotes.md‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Bing.Elasticsearch 发行说明
2+
3+
## [1.0.0](https://www.nuget.org/packages/Bing.Elasticsearch/1.0.0)
4+
5+
### ✨ 新功能
6+
7+
* 🧩 初始化 ES 查询子句结构（`And`, `Or`, `Like`, `NotEqual`, `Range` 等）
8+
* 🆕 支持分页查询、ScrollAll、WhereIfNotEmpty 等扩展方法
9+
* ➕ 支持 `OrderBy`、模糊查询 `Keyword` 追加、泛型查询能力
10+
* 🔧 新增 `ConnectionSettings` 外部配置访问接口
11+
12+
---
13+
14+
### 🎨 代码重构
15+
16+
* 重构范围查询方法（`refactor: 范围方法`）
17+
* 重构条件构造逻辑，支持多种组合条件链式调用
18+
* 重构项目结构，调整测试项目引用、移除 `dependency.props`，对齐统一测试配置
19+
20+
---
21+
22+
### 🛠️ 修复 & 改进
23+
24+
* 修复默认走 `bing_es` 索引的问题（`FindByIdsAsync`）
25+
* 修复模糊查询关键词追加逻辑
26+
* 修复仓储分页兼容性问题
27+
28+
---
29+
30+
### ✅ 单元测试 & 文档
31+
32+
* 完善测试项目结构，初始化统一测试基类与配置
33+
* 添加项目 README.md、自述文档
34+
* 发布多个 Preview 版本用于验证（共 6 个 Preview）

‎docs/api/.gitignore‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
###############
2+
# temp file #
3+
###############
4+
*.yml
5+
.manifest

‎docs/api/index.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# PLACEHOLDER
2+
3+
TODO: Add .NET projects to the *src* folder and run `docfx` to generate **REAL** *API Documentation*!

‎docs/docfx.json‎

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
{
2+
"$schema": "https://raw.githubusercontent.com/dotnet/docfx/main/schemas/docfx.schema.json",
3+
"metadata": [
4+
{
5+
"src": [
6+
{
7+
"src": "../src",
8+
"files": [
9+
"**/*.csproj"
10+
],
11+
"exclude": [
12+
"**/obj/**",
13+
"**/bin/**"
14+
]
15+
}
16+
],
17+
"dest": "api",
18+
"includePrivateMembers": false,
19+
"disableGitFeatures": false,
20+
"disableDefaultFilter": false,
21+
"noRestore": false,
22+
"namespaceLayout": "flattened"
23+
}
24+
],
25+
"build": {
26+
"content": [
27+
{
28+
"files": [
29+
"**/*.{md,yml}"
30+
],
31+
"exclude": [
32+
"_site/**"
33+
]
34+
}
35+
],
36+
"resource": [
37+
{
38+
"files": [
39+
"**/images/**"
40+
]
41+
}
42+
],
43+
"overwrite":[
44+
{
45+
"files":[
46+
"apidoc/**.md"
47+
],
48+
"exclude": [
49+
"obj/**",
50+
"_site/**"
51+
]
52+
}
53+
],
54+
"output": "_site",
55+
"globalMetadata": {
56+
"_appName": "Bing.ElasticSearch",
57+
"_appTitle": "Bing.ElasticSearch",
58+
"_enableSearch": true,
59+
"pdf": true
60+
},
61+
"globalMetadataFiles": [],
62+
"fileMetadataFiles": [],
63+
"template": [
64+
"default",
65+
"modern"
66+
],
67+
"postProcessors": [],
68+
"disableGitFeatures": false
69+
}
70+
}

‎docs/index.md‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# Bing.Elasticsearch
2+
[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://mit-license.org/)
3+
4+
Bing.Elasticsearch是Bing应用框架的Elasticsearch操作类库。
5+
6+
## Nuget Packages
7+
|包名称|稳定版本|预览版本|下载数|
8+
|----|----|----|----|
9+
|[Bing.Elasticsearch](https://www.nuget.org/packages/Bing.Elasticsearch/)|[![Bing.Elasticsearch](https://img.shields.io/nuget/v/Bing.Elasticsearch.svg)](https://www.nuget.org/packages/Bing.Elasticsearch/)|[![Bing.Elasticsearch](https://img.shields.io/nuget/vpre/Bing.Elasticsearch.svg)](https://www.nuget.org/packages/Bing.Elasticsearch/)|[![Bing.Elasticsearch](https://img.shields.io/nuget/dt/Bing.Elasticsearch.svg)](https://www.nuget.org/packages/Bing.Elasticsearch/)|
10+
|[Bing.Extensions.Elasticsearch](https://www.nuget.org/packages/Bing.Extensions.Elasticsearch/)|[![Bing.Extensions.Elasticsearch](https://img.shields.io/nuget/v/Bing.Extensions.Elasticsearch.svg)](https://www.nuget.org/packages/Bing.Extensions.Elasticsearch/)|[![Bing.Extensions.Elasticsearch](https://img.shields.io/nuget/vpre/Bing.Extensions.Elasticsearch.svg)](https://www.nuget.org/packages/Bing.Extensions.Elasticsearch/)|[![Bing.Extensions.Elasticsearch](https://img.shields.io/nuget/dt/Bing.Extensions.Elasticsearch.svg)](https://www.nuget.org/packages/Bing.Extensions.Elasticsearch/)|
11+
12+
## 实现功能
13+
14+
## 依赖类库
15+
- Microsoft.Extensions.DependencyInjection
16+
- [NEST](https://github.com/elastic/elasticsearch-net)
17+
18+
## 作者
19+
20+
简玄冰
21+
22+
## 贡献与反馈
23+
24+
> 如果你在阅读或使用Bing中任意一个代码片断时发现Bug，或有更佳实现方式，请通知我们。
25+
26+
> 为了保持代码简单，目前很多功能只建立了基本结构，细节特性未进行迁移，在后续需要时进行添加，如果你发现某个类无法满足你的需求，请通知我们。
27+
28+
> 你可以通过github的Issue或Pull Request向我们提交问题和代码，如果你更喜欢使用QQ进行交流，请加入我们的交流QQ群。
29+
30+
> 对于你提交的代码，如果我们决定采纳，可能会进行相应重构，以统一代码风格。
31+
32+
> 对于热心的同学，将会把你的名字放到**贡献者**名单中。
33+
34+
## 免责声明
35+
- 虽然我们对代码已经进行高度审查，并用于自己的项目中，但依然可能存在某些未知的BUG，如果你的生产系统蒙受损失，Bing 团队不会对此负责。
36+
- 出于成本的考虑，我们不会对已发布的API保持兼容，每当更新代码时，请注意该问题。
37+
38+
## 开源地址
39+
[https://github.com/bing-framework/Bing.Elasticsearch](https://github.com/bing-framework/Bing.Elasticsearch)
40+
41+
## License
42+
43+
**MIT**
44+
45+
> 这意味着你可以在任意场景下使用 Bing 应用框架而不会有人找你要钱。
46+
47+
> Bing 会尽量引入开源免费的第三方技术框架，如有意外，还请自行了解。

‎docs/toc.yml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
- name: 主页
2+
href: index.md
3+
- name: API 文档
4+
href: api/
5+
- name: 发行说明
6+
href: ReleaseNotes.md
7+
- name: Github
8+
href: https://github.com/bing-framework/Bing.Elasticsearch

0 commit comments

Comments
 (0)