Implement buildpack (#3)

* Implement buildpack Signed-off-by: Rob Dimsdale-Zucker <[email protected]> * add an offline test * Update README.md Co-authored-by: Tim Hitchener <[email protected]> * Update README.md Co-authored-by: Tim Hitchener <[email protected]> * modify provision name to include php * manually update github config * Update README.md Co-authored-by: Rob Dimsdale-Zucker <[email protected]> Co-authored-by: Tim Hitchener <[email protected]>
ninech · Apr 1, 2022 · 1c290e5 · 1c290e5
1 parent d2ebbd0
commit 1c290e5
Show file tree

Hide file tree

Showing 38 changed files with 3,054 additions and 35 deletions.
diff --git a/.github/workflows/approve-bot-pr.yml b/.github/workflows/approve-bot-pr.yml
@@ -52,7 +52,7 @@ jobs:
 
     - name: Checkout
       if: steps.human-commits.outputs.human_commits == 'false' && steps.unverified-commits.outputs.unverified_commits == 'false'
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
 
     - name: Approve
       if: steps.human-commits.outputs.human_commits == 'false' && steps.unverified-commits.outputs.unverified_commits == 'false'

diff --git a/.github/workflows/auto-merge.yml b/.github/workflows/auto-merge.yml
@@ -12,7 +12,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: Checkout
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
 
     - name: Fetch Pull Request Details
       id: pull_request

diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml
@@ -21,7 +21,7 @@ jobs:
 
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
 
     - name: Initialize CodeQL
       uses: github/codeql-action/init@v1

diff --git a/.github/workflows/create-draft-release.yml b/.github/workflows/create-draft-release.yml
@@ -20,11 +20,11 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: Setup Go
-      uses: actions/setup-go@v2.2.0
+      uses: actions/setup-go@v3
       with:
-        go-version: 1.17.x
+        go-version: 1.18.x
     - name: Checkout
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
     - name: Run Unit Tests
       run: ./scripts/unit.sh
 
@@ -34,11 +34,11 @@ jobs:
     needs: unit
     steps:
     - name: Setup Go
-      uses: actions/setup-go@v2.2.0
+      uses: actions/setup-go@v3
       with:
-        go-version: 1.17.x
+        go-version: 1.18.x
     - name: Checkout
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
     - run: git fetch --depth=1 origin +refs/tags/*:refs/tags/* || true
     - name: Run Integration Tests
       run: ./scripts/integration.sh --use-token
@@ -51,11 +51,11 @@ jobs:
     needs: integration
     steps:
     - name: Setup Go
-      uses: actions/setup-go@v2.2.0
+      uses: actions/setup-go@v3
       with:
-        go-version: 1.17.x
+        go-version: 1.18.x
     - name: Checkout
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
     - run: git fetch --depth=1 origin +refs/tags/*:refs/tags/* || true
     - name: Reset Draft Release
       id: reset
@@ -70,6 +70,7 @@ jobs:
       with:
         repo: ${{ github.repository }}
         token: ${{ github.token }}
+        ref-name: ${{ github.ref_name }}
     - name: Set Release Tag
       id: tag
       run: |

diff --git a/.github/workflows/label-pr.yml b/.github/workflows/label-pr.yml
@@ -1,17 +1,33 @@
-name: Auto-label PR
+name: Set / Validate PR Labels
 on:
   pull_request:
     branches:
     - main
+    types:
+    - synchronize
+    - opened
+    - reopened
+    - labeled
+    - unlabeled
 
-concurrency: pr_labels
+concurrency: pr_labels_${{ github.event.number }}
 
 jobs:
-  semver-label:
-    name: Semver Auto-Label
+  autolabel:
+    name: Ensure Minimal Semver Labels
     runs-on: ubuntu-latest
     steps:
+    - name: Check Minimal Semver Labels
+      uses: mheap/github-action-required-labels@v1
+      with:
+        count: 1
+        labels: semver:major, semver:minor, semver:patch
+        mode: exactly
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
     - name: Auto-label Semver
+      if: ${{ failure() }}
       uses: paketo-buildpacks/github-config/actions/pull-request/auto-semver-label@main
       env:
         GITHUB_TOKEN: ${{ secrets.PAKETO_BOT_GITHUB_TOKEN }}
diff --git a/.github/workflows/lint-yaml.yml b/.github/workflows/lint-yaml.yml
@@ -10,16 +10,16 @@ jobs:
   lintYaml:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
 
     - name: Checkout github-config
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
       with:
         repository: paketo-buildpacks/github-config
         path: github-config
 
     - name: Set up Python
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v3
       with:
         python-version: 3.8
 

diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -13,8 +13,15 @@ jobs:
     name: lint
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
+    - name: Setup Go
+      uses: actions/setup-go@v3
+      with:
+        go-version: 1.18.x
+
+    - name: Checkout
+      uses: actions/checkout@v3
+
     - name: golangci-lint
-      uses: golangci/golangci-lint-action@v2.5.2
+      uses: golangci/golangci-lint-action@v3
       with:
-        version: v1.32.2
+        version: v1.45.2
diff --git a/.github/workflows/synchronize-labels.yml b/.github/workflows/synchronize-labels.yml
@@ -11,7 +11,7 @@ jobs:
         runs-on:
             - ubuntu-latest
         steps:
-            - uses: actions/checkout@v2
+            - uses: actions/checkout@v3
             - uses: micnncim/action-label-syncer@v1
               env:
                   GITHUB_TOKEN: ${{ github.token }}
diff --git a/.github/workflows/test-pull-request.yml b/.github/workflows/test-pull-request.yml
@@ -11,12 +11,12 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: Setup Go
-      uses: actions/setup-go@v2.2.0
+      uses: actions/setup-go@v3
       with:
-        go-version: 1.17.x
+        go-version: 1.18.x
 
     - name: Checkout
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
 
     - name: Run Unit Tests
       run: ./scripts/unit.sh
@@ -27,12 +27,12 @@ jobs:
     needs: unit
     steps:
     - name: Setup Go
-      uses: actions/setup-go@v2.2.0
+      uses: actions/setup-go@v3
       with:
-        go-version: 1.17.x
+        go-version: 1.18.x
 
     - name: Checkout
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
 
     - run: git fetch --depth=1 origin +refs/tags/*:refs/tags/* || true
 

diff --git a/.github/workflows/update-dependencies.yml b/.github/workflows/update-dependencies.yml
@@ -2,17 +2,19 @@ name: Update dependencies
 
 on:
   schedule:
-  - cron: '*/15 * * * *'
+  - cron: '15 */1 * * *'
   workflow_dispatch: {}
 
+concurrency: dependency_update
+
 jobs:
   update-dependencies:
     runs-on: ubuntu-latest
     name: Update dependencies
     steps:
 
     - name: Checkout
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
 
     - name: Checkout Branch
       uses: paketo-buildpacks/github-config/actions/pull-request/checkout-branch@main

diff --git a/.github/workflows/update-github-config.yml b/.github/workflows/update-github-config.yml
@@ -5,19 +5,21 @@ on:
   - cron: '30 1 * * *'
   workflow_dispatch: {}
 
+concurrency: github_config_update
+
 jobs:
   build:
     name: Create PR to update shared files
     runs-on: ubuntu-latest
     steps:
 
     - name: Checkout
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
       with:
         token: ${{ secrets.PAKETO_BOT_GITHUB_TOKEN }}
 
     - name: Checkout github-config
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
       with:
         repository: paketo-buildpacks/github-config
         path: github-config

diff --git a/NOTICE b/NOTICE
@@ -0,0 +1,8 @@
+Copyright (c) 2018-Present CloudFoundry.org Foundation, Inc. All Rights Reserved.
+
+This project is licensed to you under the Apache License, Version 2.0 (the "License").
+You may not use this project except in compliance with the License.
+
+This project may include a number of subcomponents with separate copyright notices
+and license terms. Your use of these subcomponents is subject to the terms and 
+conditions of the subcomponent's license, as noted in the LICENSE file.
diff --git a/README.md b/README.md
@@ -1,2 +1,80 @@
-# php-nginx
-PHP Nginx Cloud Native Buildpack
+# PHP Nginx Cloud Native Buildpack
+A Cloud Native Buildpack for configuring Nginx settings for PHP apps.
+
+The buildpack generates the Nginx configuration file with the minimal set of
+options to get Nginx to work with FPM (FastCGI Process Manager), and
+incorporates configuration from users and environment variables. The final
+Nginx configuration file is available at
+`/workspace/nginx.conf`, or locatable
+through the buildpack-set `$PHP_NGINX_PATH` environment variable at
+launch-time.
+
+## Integration
+
+The PHP Nginx CNB provides `php-nginx-config`, which can be required by subsequent
+buildpacks. In order to configure Nginx, the user must declare the intention to
+use Nginx as the web-server by setting the `$BP_PHP_SERVER` environment
+variable to `nginx` at build-time.
+
+```shell
+pack build my-nginx-app --env BP_PHP_SERVER="nginx"
+```
+
+## Nginx Configuration Sources 
+The base configuration file generated in this buildpack includes some default configuration, FPM-specific configuration, and
+has `include` sections for user-included configuration.
+
+#### FPM-specific Configuration
+This buildpack is written to provide Nginx configuration that should always be
+used in conjunction with FPM. The Nginx configuration file is generated to
+include FPM-specific configuration. This buildpack also sets up an FPM
+configuration file with Nginx-specific socket settings and makes it available
+in the `/workspace`.
+
+#### User Included Configuration
+User-included configuration should be found in the application source directory
+under `<app-directory>/.nginx.conf.d/`. Server-specific configuration should be
+inside a file named `*-server.conf`, and HTTP configuration should be inside a
+file with the naming structure `*-http.conf`.
+
+If files at these paths exist, it
+will be included in `include` sections at the appropriate places in the generated
+Nginx configuration.
+
+#### Environment Variables
+The following environment variables can be used to override default settings in
+the Nginx configuration file.
+
+| Variable | Default |
+| -------- | -------- |
+| `BP_PHP_ENABLE_HTTPS_REDIRECT`   | true    |
+| `BP_PHP_WEB_DIR`    | htdocs    |
+
+## Usage
+
+To package this buildpack for consumption:
+
+```
+$ ./scripts/package.sh
+```
+
+This builds the buildpack's Go source using `GOOS=linux` by default. You can
+supply another value as the first argument to `package.sh`.
+
+## Run Tests
+
+To run all unit tests, run:
+```
+./scripts/unit.sh
+```
+
+To run all integration tests, run:
+```
+./scripts/integration.sh
+```
+
+## Debug Logs
+For extra debug logs from the image build process, set the `$BP_LOG_LEVEL`
+environment variable to `DEBUG` at build-time (ex. `pack build my-app --env
+BP_LOG_LEVEL=DEBUG` or through a  [`project.toml`
+file](https://github.com/buildpacks/spec/blob/main/extensions/project-descriptor.md).