From 8e9f43cb19423f7bc55a0dcf601e872ba45d6aaf Mon Sep 17 00:00:00 2001 From: bidi Date: Wed, 12 Nov 2025 16:20:48 +0200 Subject: [PATCH 1/2] updated readme, security Signed-off-by: bidi --- README.md | 9 +++++++++ SECURITY.md | 14 +++++++------- 2 files changed, 16 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 4b058e6..c30c5bd 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,15 @@ Logging Error Handler for DotKernel [![SymfonyInsight](https://insight.symfony.com/projects/cf1f8d89-f230-4157-bc8b-7cce20c75454/big.svg)](https://insight.symfony.com/projects/cf1f8d89-f230-4157-bc8b-7cce20c75454) +## Version History + +| Branch | Release | PSR-11 | Log Style Implementation | OSS Lifecycle | PHP Version | +|--------|----------|--------|--------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------| +| 4.1 | `>= 4.2` | 2 | PSR-Log | ![OSS Lifecycle](https://img.shields.io/osslifecycle?file_url=https%3A%2F%2Fgithub.com%2Fdotkernel%2Fdot-errorhandler%2Fblob%2F4.1%2FOSSMETADATA) | ![PHP from Packagist (specify version)](https://img.shields.io/packagist/php-v/dotkernel/dot-errorhandler/4.4.1) | +| 4.1 | `< 4.2` | 2 | Laminas Log | ![OSS Lifecycle](https://img.shields.io/osslifecycle?file_url=https%3A%2F%2Fgithub.com%2Fdotkernel%2Fdot-errorhandler%2Fblob%2F4.1%2FOSSMETADATA) | ![PHP from Packagist (specify version)](https://img.shields.io/packagist/php-v/dotkernel/dot-errorhandler/4.1.1) | +| 4.0 | `< 4.1` | 1 | Laminas Log | ![OSS Lifecycle](https://img.shields.io/osslifecycle?file_url=https%3A%2F%2Fgithub.com%2Fdotkernel%2Fdot-errorhandler%2Fblob%2F4.0%2FOSSMETADATA) | ![PHP from Packagist (specify version)](https://img.shields.io/packagist/php-v/dotkernel/dot-errorhandler/4.0.2) | +| 3.0 | `< 4.0` | 1 | Laminas Log | ![OSS Lifecycle](https://img.shields.io/osslifecycle?file_url=https%3A%2F%2Fgithub.com%2Fdotkernel%2Fdot-errorhandler%2Fblob%2F3.0%2FOSSMETADATA) | ![PHP from Packagist (specify version)](https://img.shields.io/packagist/php-v/dotkernel/dot-errorhandler/3.4.1) | + ## Adding the error handler - Add the composer package: diff --git a/SECURITY.md b/SECURITY.md index 054ef92..a471dd1 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -2,12 +2,13 @@ ## Supported Versions - -| Version | Supported | PHP Version | -|---------|--------------------|-----------------------------------------------------------------------------------------------------------------------| -| 3.x | :white_check_mark: | ![PHP from Packagist (specify version)](https://img.shields.io/packagist/php-v/dotkernel/dot-errorhandler/3.3.2) | -| <= 2.x | :x: | | - +| Version | Supported | PHP Version | +|---------|---------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------| +| 4.1 | ![OSS Lifecycle](https://img.shields.io/osslifecycle?file_url=https%3A%2F%2Fgithub.com%2Fdotkernel%2Fdot-errorhandler%2Fblob%2F4.1%2FOSSMETADATA) | ![PHP from Packagist (specify version)](https://img.shields.io/packagist/php-v/dotkernel/dot-errorhandler/4.4.1) | +| 4.1 | ![OSS Lifecycle](https://img.shields.io/osslifecycle?file_url=https%3A%2F%2Fgithub.com%2Fdotkernel%2Fdot-errorhandler%2Fblob%2F4.1%2FOSSMETADATA) | ![PHP from Packagist (specify version)](https://img.shields.io/packagist/php-v/dotkernel/dot-errorhandler/4.1.1) | +| 4.0 | ![OSS Lifecycle](https://img.shields.io/osslifecycle?file_url=https%3A%2F%2Fgithub.com%2Fdotkernel%2Fdot-errorhandler%2Fblob%2F4.0%2FOSSMETADATA) | ![PHP from Packagist (specify version)](https://img.shields.io/packagist/php-v/dotkernel/dot-errorhandler/4.0.2) | +| 3.x | ![OSS Lifecycle](https://img.shields.io/osslifecycle?file_url=https%3A%2F%2Fgithub.com%2Fdotkernel%2Fdot-errorhandler%2Fblob%2F3.0%2FOSSMETADATA) | ![PHP from Packagist (specify version)](https://img.shields.io/packagist/php-v/dotkernel/dot-errorhandler/3.4.1) | +| <= 2.x | :x: | | ## Reporting Potential Security Issues @@ -27,7 +28,6 @@ release prior to any public exposure; this helps protect the project's users, and provides them with a chance to upgrade and/or update in order to protect their applications. - ## Policy If we verify a reported security vulnerability, our policy is: From 02744bcdda89412a46c449a58ec2ac227a405a5f Mon Sep 17 00:00:00 2001 From: bidi Date: Thu, 13 Nov 2025 15:58:02 +0200 Subject: [PATCH 2/2] updated oss, removed docs Signed-off-by: bidi --- .github/workflows/docs-build.yml | 16 ------- OSSMETADATA | 2 +- docs/book/index.md | 1 - docs/book/v3/configuration.md | 76 -------------------------------- docs/book/v3/installation.md | 5 --- docs/book/v3/overview.md | 6 --- mkdocs.yml | 18 -------- 7 files changed, 1 insertion(+), 123 deletions(-) delete mode 100644 .github/workflows/docs-build.yml delete mode 100644 docs/book/index.md delete mode 100644 docs/book/v3/configuration.md delete mode 100644 docs/book/v3/installation.md delete mode 100644 docs/book/v3/overview.md delete mode 100644 mkdocs.yml diff --git a/.github/workflows/docs-build.yml b/.github/workflows/docs-build.yml deleted file mode 100644 index 1a7aa24..0000000 --- a/.github/workflows/docs-build.yml +++ /dev/null @@ -1,16 +0,0 @@ -name: docs-build - -on: - release: - types: [published] - workflow_dispatch: - -jobs: - build-deploy: - runs-on: ubuntu-latest - steps: - - name: Build Docs - uses: dotkernel/documentation-theme/github-actions/docs@main - env: - DEPLOY_TOKEN: ${{ secrets.GITHUB_TOKEN }} - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/OSSMETADATA b/OSSMETADATA index b96d4a4..8bff0a1 100644 --- a/OSSMETADATA +++ b/OSSMETADATA @@ -1 +1 @@ -osslifecycle=active +osslifecycle=maintenance diff --git a/docs/book/index.md b/docs/book/index.md deleted file mode 100644 index fe84005..0000000 --- a/docs/book/index.md +++ /dev/null @@ -1 +0,0 @@ -../../README.md \ No newline at end of file diff --git a/docs/book/v3/configuration.md b/docs/book/v3/configuration.md deleted file mode 100644 index ae1f365..0000000 --- a/docs/book/v3/configuration.md +++ /dev/null @@ -1,76 +0,0 @@ -# Configuration - -Register `dot-errorhandler` in you project by adding `Dot\ErrorHandler\ConfigProvider::class` to your configuration aggregator (to `config/config.php` for example), -and add `\Dot\ErrorHandler\ErrorHandlerInterface::class` (to `config/pipeline.php` for example) **as the outermost layer of the middleware** to catch all Exceptions - -- Configure the error handler as shown below - -config/autoload/error-handling.global.php - -```php - [ - 'aliases' => [ - ErrorHandlerInterface::class => LogErrorHandler::class, - ] - - ], - 'dot-errorhandler' => [ - 'loggerEnabled' => true, - 'logger' => 'dot-log.default_logger' - ] -]; -``` - -A configuration example for the default logger can be found in `config/log.global.php.dist`. - -When declaring the `ErrorHandlerInterface` alias you can choose whether to log or not: - -- for the simple Zend Expressive handler user `ErrorHandler` -- for logging use `LogErrorHandler` - -The class `Dot\ErrorHandler\ErrorHandler` is the same as the Zend Expressive error handling class -the only difference being the removal of the `final` statement for making extension possible. - -The class `Dot\ErrorHandler\LogErrorHandler` is `Dot\ErrorHandler\ErrorHandler` with -added logging support. - -As a note: both `LogErrorHandler` and `ErrorHandler` have factories declared in the -package's `ConfigProvider`. If you need a custom ErrorHandler it must have a factory -declared in the config, as in the example. - -Example: - -```php - [ - 'factories' => [ - MyErrorHandler::class => MyCustomHandlerFactory::class, - ], - - 'aliases' => [ - ErrorHandlerInterface::class => MyErrorHandler::class, - ] - - ], - 'dot-errorhandler' => [ - 'loggerEnabled' => true, - 'logger' => 'dot-log.default_logger' - ] -]; -``` - -Config examples can be found in this project's `config` directory. diff --git a/docs/book/v3/installation.md b/docs/book/v3/installation.md deleted file mode 100644 index 723581c..0000000 --- a/docs/book/v3/installation.md +++ /dev/null @@ -1,5 +0,0 @@ -# Installation - -Install `dotkernel/dot-errorhandler` by executing the following Composer command: - - composer require dotkernel/dot-errorhandler diff --git a/docs/book/v3/overview.md b/docs/book/v3/overview.md deleted file mode 100644 index c124631..0000000 --- a/docs/book/v3/overview.md +++ /dev/null @@ -1,6 +0,0 @@ -# Overview - -`dot-errorhandler` is DotKernel's logging error handler, providing two options: - -- `Dot\ErrorHandler\ErrorHandler`, same as the Zend Expressive error handling class with the only difference being the removal of the `final` statement for making extension possible -- `Dot\ErrorHandler\LogErrorHandler` adds logging support to the default `ErrorHandler` class diff --git a/mkdocs.yml b/mkdocs.yml deleted file mode 100644 index e744b94..0000000 --- a/mkdocs.yml +++ /dev/null @@ -1,18 +0,0 @@ -docs_dir: docs/book -site_dir: docs/html -extra: - project: Packages - current_version: v3 - versions: - - v3 -nav: - - Home: index.md - - v3: - - Overview: v3/overview.md - - Installation: v3/installation.md - - Configuration: v3/configuration.md -site_name: dot-errorhandler -site_description: "DotKernel's logging error handler" -repo_url: "https://github.com/dotkernel/dot-errorhandler" -plugins: - - search