Skip to content

Commit 20e992f

Browse files
authored
docs(amqp-job): add introduction section to clarify component functionality (#807)
* docs(amqp-job): add introduction section to clarify component functionality * fix(workflows): update paths-ignore pattern to exclude all subdirectories in docs * fix(config): set collapse_walkthrough to false in coderabbit configuration * fix(workflows): update paths to include all files while excluding docs, .vscode, and markdown files --------- Co-authored-by: Deeka Wong <[email protected]>
1 parent f575083 commit 20e992f

File tree

3 files changed

+16
-5
lines changed

3 files changed

+16
-5
lines changed

.coderabbit.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ reviews:
88
commit_status: true
99
poem: true
1010
review_status: true
11-
collapse_walkthrough: true
11+
collapse_walkthrough: false
1212
auto_review:
1313
enabled: true
1414
drafts: true

.github/workflows/tests.yaml

+10-4
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,17 @@ name: tests
22

33
on:
44
push:
5-
paths-ignore:
6-
- "docs/"
5+
paths:
6+
- "**"
7+
- "!docs/**"
8+
- "!.vscode/**"
9+
- "!**.md"
710
pull_request:
8-
paths-ignore:
9-
- "docs/"
11+
paths:
12+
- "**"
13+
- "!docs/**"
14+
- "!.vscode/**"
15+
- "!**.md"
1016
schedule:
1117
- cron: '0 2 * * *'
1218

docs/en/components/amqp-job.md

+5
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
# Amqp Job
22

3+
## Introduction
4+
5+
`friendsofhyperf/amqp-job` is an asynchronous job component based on the `hyperf/amqp` component. It supports dispatching jobs to an AMQP service and then consuming the jobs through consumers.
6+
It encapsulates the `hyperf/amqp` component and provides a more convenient way to dispatch and consume jobs.
7+
38
## Installation
49

510
```shell

0 commit comments

Comments
 (0)