Bref v3

.github/aws/github-role.yml

@@ -15,12 +15,12 @@ Resources:
                     - Effect: Allow
                       Action: sts:AssumeRoleWithWebIdentity
                       Principal:
-                          Federated: arn:aws:iam::534081306603:oidc-provider/token.actions.githubusercontent.com
+                          Federated: arn:aws:iam::873528684822:oidc-provider/token.actions.githubusercontent.com
                       Condition:
                           StringLike:
                               token.actions.githubusercontent.com:sub: !Sub repo:${FullRepoName}:*
             Policies:
-                -   PolicyName: RetrieveLayersForLayerJsRole
+                -   PolicyName: RetrieveLayersForLayerRole
                     PolicyDocument:
                         Statement:
                             -   Effect: Allow

.github/workflows/ci.yml

@@ -2,7 +2,7 @@ name: CI
 
 on:
     push:
-        branches: ['master']
+        branches: ['master', 'v3']
     pull_request:
         branches: ['*']
     schedule:
@@ -16,11 +16,11 @@ jobs:
         timeout-minutes: 15
         strategy:
             matrix:
-                php: [ '8.4', '8.3', '8.2', '8.1', '8.0' ]
+                php: [ '8.5', '8.4', '8.3', '8.2' ]
                 dependency-version: [ '' ]
                 platform-reqs: [ '' ]
                 include:
-                    -   php: '8.0'
+                    -   php: '8.2'
                         dependency-version: '--prefer-lowest'
         steps:
             -   name: Checkout
@@ -40,7 +40,7 @@ jobs:
                     coverage: none
                     ini-values: expose_php=1
             -   name: Install dependencies
-                run: 'composer update ${{ matrix.dependency-version }} --no-interaction --prefer-dist --no-progress --no-security-blocking ${{ matrix.platform-reqs }}'
+                run: 'composer update ${{ matrix.dependency-version }} --no-interaction --prefer-dist --no-progress ${{ matrix.platform-reqs }}'
             -   name: Execute Unit Tests
                 run: 'vendor/bin/phpunit --testsuite small'
 

.github/workflows/update-layer-versions.yml

@@ -1,4 +1,4 @@
-name: Update layer versions (Bref v2)
+name: Update layer versions
 
 # Triggered manually or automatically when new Bref layers published
 on:
@@ -26,12 +26,12 @@ jobs:
         steps:
             -   uses: actions/checkout@v4
                 with:
-                    ref: master
+                    ref: v3 # temporary until v3 becomes the main branch
 
             -   name: Set AWS credentials
                 uses: aws-actions/configure-aws-credentials@v4
                 with:
-                    role-to-assume: arn:aws:iam::534081306603:role/bref-github-actions
+                    role-to-assume: arn:aws:iam::873528684822:role/bref-github-actions
                     role-session-name: bref-github-actions
                     aws-region: us-east-1
 
@@ -47,10 +47,10 @@ jobs:
             -   run: make layers.json
 
             -   name: Create Pull Request
-                uses: peter-evans/create-pull-request@v5
+                uses: peter-evans/create-pull-request@v7
                 with:
                     commit-message: Update layer versions
-                    title: Update Lambda layers [${{ inputs.release_name }}](${{ inputs.release_html_url }})
+                    title: Update v3 layers [${{ inputs.release_name }}](${{ inputs.release_html_url }})
                     body: |
                         New AWS Lambda layers [have been released](https://github.com/brefphp/aws-lambda-layers/releases):
 
@@ -60,8 +60,6 @@ jobs:
                         After merging, a new Bref release needs to be created.
 
                         If you are using AWS Lambda layer ARNs, check out [runtimes.bref.sh](https://runtimes.bref.sh/) to see the latest ARNs.
-                    branch: new-layer-versions
+                    branch: new-layer-versions-v3
+                    base: v3 # temporary until v3 becomes the main branch
                     delete-branch: true # delete after merging or closing the PR
-                    # https://github.com/actions/checkout/issues/13#issuecomment-724415212
-                    committer: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
-                    author: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

.phpcs.xml

@@ -7,7 +7,6 @@
     <!-- Show sniff names -->
     <arg value="s"/>
 
-    <file>bref</file>
     <file>src</file>
     <file>tests</file>
 

composer.json

@@ -16,11 +16,10 @@
         }
     },
     "bin": [
-        "bref",
         "src/bref-local"
     ],
     "require": {
-        "php": ">=8.0",
+        "php": ">=8.2",
         "ext-curl": "*",
         "ext-json": "*",
         "crwlr/query-string": "^1.0.3",
@@ -30,7 +29,7 @@
         "psr/http-message": "^1.0|^2.0",
         "psr/http-server-handler": "^1.0",
         "riverline/multipart-parser": "^2.1.2",
-        "symfony/process": "^4.4|^5.0|^6.0|^7.0|^8.0"
+        "symfony/process": "^5.4|^6.4|^7.0|^8.0"
     },
     "require-dev": {
         "async-aws/core": "^1.0",
@@ -42,8 +41,8 @@
         "guzzlehttp/guzzle": "^7.5",
         "phpstan/phpstan": "^1.10.26",
         "phpunit/phpunit": "^9.6.10",
-        "symfony/console": "^4.4|^5.0|^6.0|^7.0|^8.0",
-        "symfony/yaml": "^4.4|^5.0|^6.0|^7.0|^8.0"
+        "symfony/console": "^5.4|^6.4|^7.0|^8.0",
+        "symfony/yaml": "^5.4|^6.4|^7.0|^8.0"
     },
     "scripts": {
         "test": [

demo/http.php

@@ -2,6 +2,10 @@
 
 require __DIR__ . '/../vendor/autoload.php';
 
+if (isset($_GET['crash'])) {
+    throw new \Exception('Crash!');
+}
+
 if (isset($_GET['sleep'])) {
     error_log('This is a log');
     sleep(10);

docs/default/cli-commands.mdx

@@ -8,7 +8,7 @@ We can run CLI commands and scripts on AWS Lambda by deploying a "console" funct
 functions:
     cli:
         handler: the-php-script-to-run.php
-        runtime: php-81-console
+        runtime: php-84-console
 ```
 
 The function uses the [Console runtime](../runtimes/console.mdx).

docs/default/getting-started.mdx

@@ -27,33 +27,29 @@ Next, in an empty directory, install Bref using Composer:
 composer require bref/bref
 ```
 
-Make sure that the version of Bref that was installed is 1.0 or greater.
+Make sure that the version of Bref that was installed is 3.0 or greater.
 
-Then let's start by initializing a new project by running:
+Then, create a `serverless.yml` file. This file will describe how to deploy your application.
 
-```bash
-vendor/bin/bref init
-```
-
-Accept all the defaults by pressing "Enter". The following files will be created in your project:
-
-- `index.php` contains the code of your application
-- `serverless.yml` contains the configuration for deploying on AWS
-
-You are free to edit `index.php`.
+```yml filename="serverless.yml"
+service: app # your application name (lowercase without spaces)
 
-To deploy an existing application, you can delete `index.php` and edit `serverless.yml` to point to your existing index file (for example it may be another file like `public/index.php`). You can also create the `serverless.yml` file manually:
+bref:
+    # Uncomment and set your team ID if you are using Bref Cloud
+    #team: bref-team-id
 
-```yml filename="serverless.yml"
-service: app
 provider:
     name: aws
-    region: us-east-1
+    region: us-east-1 # AWS region to deploy to
+    environment: # Environment variables
+        APP_ENV: prod
 
 functions:
     web:
+        # `index.php` is the entrypoint of your application
         handler: index.php
-        runtime: php-81-fpm
+        runtime: php-84-fpm
+        timeout: 28 # in seconds (API Gateway has a max timeout of 29 seconds)
         events:
             -   httpApi: '*'
 
@@ -66,6 +62,21 @@ plugins:
     - ./vendor/bref/bref
 ```
 
+If your `index.php` entrypoint is in a different folder, feel free to adjust the `handler` key. For example if it is in `public/index.php`:
+
+```yml
+        handler: public/index.php
+```
+
+If this is a new application, you can create a very simple `index.php` file to test things out, for example:
+
+```php
+<?php
+echo 'Hello world!';
+```
+
+You will also want to add `.serverless` to your `.gitignore`.
+
 ## Deployment
 
 To deploy, run: