From 0dea6f7d9035669f5398f203cd7558f4ab6a5d2a Mon Sep 17 00:00:00 2001 From: Laurent Laville Date: Thu, 28 Nov 2024 04:45:09 +0000 Subject: [PATCH] prepare feature/bugfix release 4.1.0 --- .changes/4.1.0.md | 32 ++++++++++++++++++++++++++++++++ .github/workflows/gh-pages.yml | 2 +- .github/workflows/unit-tests.yml | 2 +- CHANGELOG.md | 32 ++++++++++++++++++++++++++++++++ README.md | 4 ++-- composer.json | 5 ++--- docs/getting-started.md | 6 +++--- mkdocs.yml | 2 +- 8 files changed, 74 insertions(+), 11 deletions(-) create mode 100644 .changes/4.1.0.md diff --git a/.changes/4.1.0.md b/.changes/4.1.0.md new file mode 100644 index 0000000..bdeb017 --- /dev/null +++ b/.changes/4.1.0.md @@ -0,0 +1,32 @@ + +## 4.1.0 - 2024-11-28 + +### Added + +- `Bartlett\BoxManifest\Helper\BoxConfigurationHelper` class handle now the BOX configuration settings +required by BOX Manifest instead of `Bartlett\BoxManifest\Helper\BoxHelper::getBoxConfiguration()` + +### Changed + +- BOX `alias` setting is internally set to **box-auto-generated-alias.phar** value, if not defined by BOX config file(s) + +- Pipeline payload contents has changed : + - **configuration** contains now an instance of `Bartlett\BoxManifest\Helper\BoxConfigurationHelper` instead of `KevinGH\Box\Configuration\Configuration` + - **map** and **configurationFile** were removed (because can be internally retrieved by the new BoxConfigurationHelper) + +- `Bartlett\BoxManifest\StubGenerator` removed dependency to legacy BOX `KevinGH\Box\StubGenerator` + +- Use the `symfony/process` [ExecutableFinder](https://symfony.com/doc/current/components/process.html#finding-an-executable) +to find default `box` vendor binary + +### Fixed + +- Always use [`Phar::mapPhar`](https://www.php.net/manual/en/phar.mapphar.php) +to solve an issue when BOX `alias` setting was not previously defined + +### Removed + +- `resources` directory, because template(s) are now handled internally by `Bartlett\BoxManifest\StubGenerator` +- `stub.php` file. Will now be generated on fly + +**Full Changelog**: [4.0.2...4.1.0](https://github.com/llaville/box-manifest/compare/4.0.2...4.1.0) diff --git a/.github/workflows/gh-pages.yml b/.github/workflows/gh-pages.yml index c3ba6ea..9f0083e 100644 --- a/.github/workflows/gh-pages.yml +++ b/.github/workflows/gh-pages.yml @@ -14,6 +14,6 @@ jobs: deploy: uses: llaville/.github/.github/workflows/gh-pages.yml@master with: - destination-dir: "4.0" + destination-dir: "4.1" force-orphan: false php-version: "8.2" diff --git a/.github/workflows/unit-tests.yml b/.github/workflows/unit-tests.yml index b1b3c4e..d1ad2ad 100644 --- a/.github/workflows/unit-tests.yml +++ b/.github/workflows/unit-tests.yml @@ -14,7 +14,7 @@ on: jobs: lint_files: - uses: llaville/.github/.github/workflows/mega-linter.yml@ml_v8 + uses: llaville/.github/.github/workflows/mega-linter.yml@master with: repository: ${{ github.repository }} php-version: "8.2" diff --git a/CHANGELOG.md b/CHANGELOG.md index 3874d8f..4df0a04 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,38 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html), and is generated by [Changie](https://github.com/miniscruff/changie). +## 4.1.0 - 2024-11-28 + +### Added + +- `Bartlett\BoxManifest\Helper\BoxConfigurationHelper` class handle now the BOX configuration settings + required by BOX Manifest instead of `Bartlett\BoxManifest\Helper\BoxHelper::getBoxConfiguration()` + +### Changed + +- BOX `alias` setting is internally set to **box-auto-generated-alias.phar** value, if not defined by BOX config file(s) + +- Pipeline payload contents has changed : + - **configuration** contains now an instance of `Bartlett\BoxManifest\Helper\BoxConfigurationHelper` instead of `KevinGH\Box\Configuration\Configuration` + - **map** and **configurationFile** were removed (because can be internally retrieved by the new BoxConfigurationHelper) + +- `Bartlett\BoxManifest\StubGenerator` removed dependency to legacy BOX `KevinGH\Box\StubGenerator` + +- Use the `symfony/process` [ExecutableFinder](https://symfony.com/doc/current/components/process.html#finding-an-executable) + to find default `box` vendor binary + +### Fixed + +- Always use [`Phar::mapPhar`](https://www.php.net/manual/en/phar.mapphar.php) + to solve an issue when BOX `alias` setting was not previously defined + +### Removed + +- `resources` directory, because template(s) are now handled internally by `Bartlett\BoxManifest\StubGenerator` +- `stub.php` file. Will now be generated on fly + +**Full Changelog**: [4.0.2...4.1.0](https://github.com/llaville/box-manifest/compare/4.0.2...4.1.0) + ## 4.0.2 - 2024-11-19 ### Fixed diff --git a/README.md b/README.md index 8b3145f..4cfa93c 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ Provides a Symfony Console Application with the binary command `box-manifest` th | Version | Status | Box Project Compatibility | PHP | |--------------------|--------------------|---------------------------|----------| -| `4.0.x` | Active development | `4.6.x` | `>= 8.2` | +| `4.0.x` to `4.1.x` | Active development | `4.6.x` | `>= 8.2` | | `3.0.x` to `3.5.x` | End Of Life | `4.0.x` to `4.3.x` | `>= 8.1` | | `2.0.x` to `2.3.x` | End Of Life | `4.0.x` to `4.2.x` | `>= 8.1` | | `1.0.x` to `1.2.0` | End Of Life | `3.x` | `>= 7.4` | @@ -38,4 +38,4 @@ All the documentation is available on [website][docs-website], generated from th [box-project]: https://github.com/box-project/box [cyclonedx]: https://github.com/CycloneDX [docs-folder]: https://github.com/llaville/box-manifest/tree/4.x/docs -[docs-website]: https://llaville.github.io/box-manifest/4.0 +[docs-website]: https://llaville.github.io/box-manifest/4.1 diff --git a/composer.json b/composer.json index a08581e..b33f399 100644 --- a/composer.json +++ b/composer.json @@ -45,8 +45,7 @@ "sort-packages": true, "optimize-autoloader": true, "allow-plugins": { - "bamarni/composer-bin-plugin": true, - "symfony/runtime": true + "bamarni/composer-bin-plugin": true } }, "extra": { @@ -61,7 +60,7 @@ }, "scripts": { "bin": "echo 'bin not installed'", - "code:check": "vendor/bin/phpstan analyse --configuration .github/linters/phpstan.neon.dist --ansi", + "code:check": "vendor/bin/phpstan analyse --configuration .github/linters/phpstan.neon.dist --verbose --ansi", "code:lint": "vendor/bin/phplint --configuration .github/linters/.phplint.yml --verbose --progress=indicator --ansi", "style:check": "vendor/bin/phpcs --standard=.github/linters/.phpcs.xml.dist --warning-severity=0 --colors", "tests:all": ["@putenv TERM_PROGRAM=Hyper", "vendor/bin/phpunit --configuration phpunit.xml.dist"], diff --git a/docs/getting-started.md b/docs/getting-started.md index 0955b67..a7588d0 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -10,7 +10,7 @@ If not, we recommend using [`docker`][docker]. * PHP 8.2 or greater * ext-phar -* PHPUnit 10 or greater (if you want to run unit tests) +* PHPUnit 11 or greater (if you want to run unit tests) ## Installation @@ -25,7 +25,7 @@ If not, we recommend using [`docker`][docker]. === "4.x" ```shell - composer require bartlett/box-manifest ^4 + composer require bartlett/box-manifest ^4.1 ``` > [!TIP] @@ -81,7 +81,7 @@ If not, we recommend using [`docker`][docker]. ```xml - + ``` diff --git a/mkdocs.yml b/mkdocs.yml index fee6320..21a57fe 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,6 +1,6 @@ --- site_name: Box Manifest -site_url: https://llaville.github.io/box-manifest/4.0 +site_url: https://llaville.github.io/box-manifest/4.1 repo_url: https://github.com/llaville/box-manifest # https://squidfunk.github.io/mkdocs-material/setup/adding-a-git-repository/#repository site_author: Laurent Laville edit_uri: "" # hide edit button -- https://squidfunk.github.io/mkdocs-material/setup/adding-a-git-repository/#edit-button