Skip to content

Commit 3d0f87e

Browse files
committed
Attempt build
1 parent 740d58a commit 3d0f87e

2 files changed

Lines changed: 57 additions & 17 deletions

File tree

.github/workflows/build.yml

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
name: Build with Tag
2+
3+
on:
4+
push:
5+
tags:
6+
- '*' # Triggers on any tag
7+
8+
jobs:
9+
build:
10+
runs-on: ubuntu-latest
11+
12+
steps:
13+
- name: Checkout code
14+
uses: actions/checkout@v3
15+
16+
- name: Set up PHP
17+
uses: shivammathur/setup-php@v2
18+
with:
19+
php-version: '8.2'
20+
21+
- name: Install Composer dependencies
22+
run: composer install --no-interaction --prefer-dist --optimize-autoloader
23+
24+
- name: Set up Node.js
25+
uses: actions/setup-node@v3
26+
with:
27+
node-version: '20'
28+
29+
- name: Install Node dependencies
30+
run: npm ci
31+
32+
- name: Build assets
33+
run: npm run build

README.md

Lines changed: 24 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
## Installation
2+
3+
To install Queue, unzip the zip file and place the `user/addons/queue` folder into
4+
your `system/user/addons` folder. Then login to the Control Panel and go to the
5+
Developer->Add-ons page and install Queue.
16

27
## Consuming Jobs
38

@@ -105,21 +110,6 @@ is unsurprisingly, `default`. If you use a custom queue be sure to instruct your
105110
ee('queue:QueueManager')->push(MyJob::class, 'payload', 'my_addon_queue')
106111
```
107112

108-
## Coilpack
109-
110-
If using the Redis driver, and Coilpack, in your `coilpack/.env file` add the following. This is what works if using DDEV, but
111-
you may need to make adjustments based on your environment configuration.
112-
113-
```dotenv
114-
REDIS_URL=""
115-
REDIS_HOST=redis
116-
REDIS_USERNAME=null
117-
REDIS_PASSWORD=null
118-
REDIS_PORT=6379
119-
REDIS_PREFIX=""
120-
REDIS_CLUSTER=""
121-
```
122-
123113
## Horizon
124114

125115
If you want to take your queue management to the next level you can install [Coilpack](https://expressionengine.github.io/coilpack-docs/)
@@ -136,6 +126,7 @@ In most cases Queue by itself will be enough, but if you're processing hundreds
136126
monitoring and reporting, Horizon is definitely worth exploring.
137127

138128
To install Horizon cd into your `coilpack` directory and run the following commands.
129+
139130
```
140131
composer require laravel/horizon
141132
php artisan horizon:install
@@ -146,6 +137,22 @@ installation is complete, but no supervisors have been started, so the interface
146137
right corner. To start horizon, run `php artisan horizon`. If there are any items in your queue, they should start
147138
processing.
148139

140+
## Coilpack
141+
142+
If using the Redis driver, and Coilpack, in your `coilpack/.env file` add the following. This is what works if using DDEV, but
143+
you may need to make adjustments based on your environment configuration.
144+
145+
```dotenv
146+
REDIS_URL=""
147+
REDIS_HOST=redis
148+
REDIS_USERNAME=null
149+
REDIS_PASSWORD=null
150+
REDIS_PORT=6379
151+
REDIS_PREFIX=""
152+
REDIS_CLUSTER=""
153+
```
154+
155+
149156
## Creating Jobs as an add-on developer
150157

151158
Create a class anywhere in your add-on, but it needs to be properly namespaced. For consistency
@@ -175,7 +182,7 @@ the operation.
175182

176183
To see working examples you can run the following commands.
177184

178-
This will execute queue/Commands/CommandQueueTest.php, which adds 5 jobs to the queue, each an instance of `TestJob` (see below)
185+
This will execute `queue/Commands/CommandQueueTest.php`, which adds 5 jobs to the queue, each an instance of `TestJob` (see below)
179186

180187
```bash
181188
php system/ee/eecli.php queue:test`
@@ -244,7 +251,7 @@ with any other add-ons, or ExpressionEngine itself, that might be using the same
244251

245252
## Viewing Redis keys
246253

247-
Using `redis-cli` is powerful but a little difficult to navigate. You can also use Redis Insight to connect to the Redis
254+
Using `redis-cli` is powerful but a little difficult to navigate. You can also use [Redis Insight](https://redis.io/insight/) to connect to the Redis
248255
database and view all the keys through a user friendly UI. If you're using something like DDEV to develop locally you
249256
will have to expose the Redis port from the container. In the `docker-compose.redis.yaml` file just change the port.
250257
The first value is what is exposed to your host machine. In this case I simply added a 1 to the end. In the Redis Insight

0 commit comments

Comments
 (0)