Skip to content

Commit 70974da

Browse files
committed
Update README and UPGRADING
1 parent 0bcb6e5 commit 70974da

File tree

2 files changed

+28
-3
lines changed

2 files changed

+28
-3
lines changed

README.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -61,10 +61,16 @@ This package requires Laravel 10 or 11.
6161
composer require stackkit/laravel-google-cloud-scheduler
6262
```
6363

64-
2 - Define the `STACKKIT_CLOUD_SCHEDULER_APP_URL` environment variable. This should be the URL defined in the `URL` field of your Cloud Scheduler job.
64+
2 - Define environment variables
6565

66-
```
67-
STACKKIT_CLOUD_SCHEDULER_APP_URL=https://yourdomainname.com/cloud-scheduler-job
66+
`CLOUD_SCHEDULER_APP_URL` - This should be the URL defined in the `URL` field of your Cloud Scheduler job.
67+
68+
`CLOUD_SCHEDULER_SERVICE_ACCOUNT` - The e-mail address of the service account invocating the task.
69+
70+
Optionally, you may publish the configuration file:
71+
72+
```bash
73+
php artisan vendor:publish --tag-cloud-scheduler-config
6874
```
6975

7076
3 - Ensure PHP executable is in open_basedir. This is required for the package to run Artisan commands.

UPGRADING.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# From 2.x to 3.x
2+
3+
Support for Laravel 6, 7, 8, and 9 has been dropped. The minimum supported version is now Laravel 10.
4+
5+
## Environment changes (Impact: high)
6+
7+
Publish the new configuration file:
8+
9+
```bash
10+
php artisan vendor:publish --tag=cloud-scheduler-config
11+
```
12+
13+
Change the environment variables names:
14+
15+
- `STACKKIT_CLOUD_SCHEDULER_APP_URL` -> `CLOUD_SCHEDULER_APP_URL`
16+
17+
Add the following environment variable:
18+
19+
- `CLOUD_SCHEDULER_SERVICE_ACCOUNT` - The e-mail address of the service account invocating the task.

0 commit comments

Comments
 (0)