Remove buildpack.yml support (#377)

* remove buildpack.yml support

* update README

Co-authored-by: Tim Hitchener <thitch97@users.noreply.github.com>

Author: Sophie Wigmore

README.md

@@ -61,13 +61,49 @@ This buildpack is released under version 2.0 of the [Apache License][a].
 
 [a]: http://www.apache.org/licenses/LICENSE-2.0
 
-## `buildpack.yml` Configurations
-
-In order to specify a particular version of `php` you can
-provide an optional `buildpack.yml` in the root of the application directory.
-```yaml
-php:
-  # this allows you to specify a version constraint for the `php` depdendency
-  # any valid semver constaints (e.g. 7.*) are also acceptable
-  version: 7.2.*
+## Run Tests
+
+To run all unit tests, run:
+```
+./scripts/unit.sh
+```
+
+To run all integration tests, run:
+```
+./scripts/integration.sh
+```
+
+## Buildpack Configurations
+
+### PHP Version
+Specifying the PHP Dist version through buildpack.yml configuration is deprecated.
+
+To migrate from using `buildpack.yml` please set the `$BP_PHP_VERSION`
+environment variable at build time either directly (ex. `pack build my-app
+--env BP_PHP_VERSION=7.3.*`) or through a [`project.toml`
+file](https://github.com/buildpacks/spec/blob/main/extensions/project-descriptor.md)
+
+```shell
+# this allows you to specify a version constraint for the `php` depdendency
+# any valid semver constaints (e.g. 7.*) are also acceptable
+$BP_PHP_VERSION="7.3.*"
+```
+### PHP library directory
+The PHP library directory is available to PHP via an include path in the PHP
+configuration. By default it is set to `/workspace/lib` and can be overriden by
+setting the `BP_PHP_LIB_DIR` environment variable at build-time.
+```shell
+$BP_PHP_LIB_DIR="some-directory"
 ```
+
+### Provide custom `.ini` files
+Custom `.ini` files can be provided from users to amend the default `php.ini`
+file. This can be done by placing an `ini`-type configuration file inside
+`<application directory>/.php.ini.d/`. It's path will be made avaialble via the
+`PHP_INI_SCAN_DIR`.
+
+## 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).

build.go

@@ -6,7 +6,6 @@ import (
 	"strings"
 	"time"
 
-	"github.com/Masterminds/semver"
 	"github.com/paketo-buildpacks/packit/v2"
 	"github.com/paketo-buildpacks/packit/v2/chronos"
 	"github.com/paketo-buildpacks/packit/v2/postal"
@@ -87,14 +86,6 @@ func Build(entryResolver EntryResolver,
 
 		logger.SelectedDependency(entry, dependency, clock.Now())
 
-		source, _ := entry.Metadata["version-source"].(string)
-		if source == "buildpack.yml" {
-			nextMajorVersion := semver.MustParse(context.BuildpackInfo.Version).IncMajor()
-			logger.Subprocess("WARNING: Setting the PHP version through buildpack.yml will be deprecated in %s v%s.", context.BuildpackInfo.Name, nextMajorVersion.String())
-			logger.Subprocess("In versions >= v%s, use the $BP_PHP_VERSION environment variable to specify a version.", nextMajorVersion.String())
-			logger.Break()
-		}
-
 		logger.Debug.Process("Getting the layer associated with PHP:")
 		phpLayer, err := context.Layers.Get(PHPDependency)
 		if err != nil {

build_test.go

@@ -159,7 +159,6 @@ func testBuild(t *testing.T, context spec.G, it spec.S) {
 		}))
 		Expect(entryResolver.ResolveCall.Receives.Priorities).To(Equal([]interface{}{
 			"BP_PHP_VERSION",
-			"buildpack.yml",
 			"composer.lock",
 			"composer.json",
 			"default-versions",

buildpack_yml_parser.go

@@ -8,7 +8,6 @@ const (
 
 var EntryPriorities = []interface{}{
 	"BP_PHP_VERSION",
-	"buildpack.yml",
 	"composer.lock",
 	"composer.json",
 	"default-versions",

buildpack_yml_parser_test.go

@@ -2,18 +2,12 @@ package phpdist
 
 import (
 	"os"
-	"path/filepath"
 
 	"github.com/paketo-buildpacks/packit/v2"
 )
 
 //go:generate faux --interface VersionParser --output fakes/version_parser.go
 
-// VersionParser defines the interface for determining the version of php.
-type VersionParser interface {
-	ParseVersion(path string) (version string, err error)
-}
-
 // BuildPlanMetadata is the buildpack specific data included in build plan
 // requirements.
 type BuildPlanMetadata struct {
@@ -25,7 +19,7 @@ type BuildPlanMetadata struct {
 // detect phase of the buildpack lifecycle.
 //
 // Detect always passes, and will contribute a Build Plan that provides php.
-func Detect(buildpackYMLParser VersionParser) packit.DetectFunc {
+func Detect() packit.DetectFunc {
 	return func(context packit.DetectContext) (packit.DetectResult, error) {
 		var requirements []packit.BuildPlanRequirement
 
@@ -40,22 +34,6 @@ func Detect(buildpackYMLParser VersionParser) packit.DetectFunc {
 			})
 		}
 
-		var err error
-		version, err = buildpackYMLParser.ParseVersion(filepath.Join(context.WorkingDir, "buildpack.yml"))
-		if err != nil {
-			return packit.DetectResult{}, err
-		}
-
-		if version != "" {
-			requirements = append(requirements, packit.BuildPlanRequirement{
-				Name: "php",
-				Metadata: BuildPlanMetadata{
-					Version:       version,
-					VersionSource: "buildpack.yml",
-				},
-			})
-		}
-
 		return packit.DetectResult{
 			Plan: packit.BuildPlan{
 				Provides: []packit.BuildPlanProvision{