feat: Update for Craft 5

nystudio107 · Apr 27, 2024 · 7688e6d · 7688e6d
1 parent af01a4d
commit 7688e6d
Show file tree

Hide file tree

Showing 7 changed files with 22 additions and 37 deletions.
diff --git a/.github/workflows/build-and-deploy-docs.yml b/.github/workflows/build-and-deploy-docs.yml
@@ -1,15 +1,15 @@
 name: Build and Deploy Docs
 env:
-  DOCS_DEST_DIR: /twig-profiler/v4/
+  DOCS_DEST_DIR: /twig-profiler/
 on:
   push:
     branches:
-      - v4
+      - v5
     paths:
       - 'docs/**'
   pull_request:
     branches:
-      - v4
+      - v5
     paths:
       - 'docs/**'
   workflow_dispatch:

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,17 +2,6 @@
 
 All notable changes to this project will be documented in this file.
 
-## 4.0.0 - UNRELEASED
+## 5.0.0 - UNRELEASED
 ### Added
-* Added `ServicesTrait` for the plugin service component registration
-* Add `phpstan` and `ecs` code linting
-* Add `code-analysis.yaml` GitHub action
-
-### Changed
-* Updated docs to use node 20 & a new sitemap plugin
-* PHPstan code cleanup
-* ECS code cleanup
-
-## 4.0.0-beta.1 - 2022.03.14
-### Added
-* Initial Craft CMS 4 compatibility
+* Stable release for Craft CMS 5
diff --git a/README.md b/README.md
@@ -1,14 +1,14 @@
-[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/nystudio107/craft-twigprofiler/badges/quality-score.png?b=v4)](https://scrutinizer-ci.com/g/nystudio107/craft-twigprofiler/?branch=v4) [![Code Coverage](https://scrutinizer-ci.com/g/nystudio107/craft-twigprofiler/badges/coverage.png?b=v4)](https://scrutinizer-ci.com/g/nystudio107/craft-twigprofiler/?branch=v4) [![Build Status](https://scrutinizer-ci.com/g/nystudio107/craft-twigprofiler/badges/build.png?b=v4)](https://scrutinizer-ci.com/g/nystudio107/craft-twigprofiler/build-status/v4) [![Code Intelligence Status](https://scrutinizer-ci.com/g/nystudio107/craft-twigprofiler/badges/code-intelligence.svg?b=v4)](https://scrutinizer-ci.com/code-intelligence)
+[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/nystudio107/craft-twigprofiler/badges/quality-score.png?b=v5)](https://scrutinizer-ci.com/g/nystudio107/craft-twigprofiler/?branch=v5) [![Code Coverage](https://scrutinizer-ci.com/g/nystudio107/craft-twigprofiler/badges/coverage.png?b=v5)](https://scrutinizer-ci.com/g/nystudio107/craft-twigprofiler/?branch=v5) [![Build Status](https://scrutinizer-ci.com/g/nystudio107/craft-twigprofiler/badges/build.png?b=v5)](https://scrutinizer-ci.com/g/nystudio107/craft-twigprofiler/build-status/v5) [![Code Intelligence Status](https://scrutinizer-ci.com/g/nystudio107/craft-twigprofiler/badges/code-intelligence.svg?b=v5)](https://scrutinizer-ci.com/code-intelligence)
 
-# Twig Profiler plugin for Craft CMS 4.x
+# Twig Profiler plugin for Craft CMS 5.x
 
 Twig Profiler allows you to profile sections of your Twig templates, and see the resulting timings in the Yii2 Debug Toolbar
 
 ![Screenshot](./docs/docs/resources/img/plugin-logo.png)
 
 ## Requirements
 
-This plugin requires Craft CMS 4.0.0 or later.
+This plugin requires Craft CMS 5.0.0 or later.
 
 ## Installation
 

diff --git a/composer.json b/composer.json
@@ -2,7 +2,7 @@
   "name": "nystudio107/craft-twigprofiler",
   "description": "Twig Profiler allows you to profile sections of your Twig templates, and see the resulting timings in the Yii2 Debug Toolbar",
   "type": "craft-plugin",
-  "version": "4.0.0",
+  "version": "5.0.0",
   "keywords": [
     "craft",
     "cms",
@@ -23,7 +23,8 @@
     }
   ],
   "require": {
-    "craftcms/cms": "^4.0.0"
+    "php": "^8.2",
+    "craftcms/cms": "^5.0.0"
   },
   "require-dev": {
     "craftcms/ecs": "dev-main",
@@ -43,11 +44,6 @@
     "optimize-autoloader": true,
     "sort-packages": true
   },
-  "autoload": {
-    "psr-4": {
-      "nystudio107\\minify\\": "src/"
-    }
-  },
   "autoload": {
     "psr-4": {
       "nystudio107\\twigprofiler\\": "src/"

diff --git a/docs/Makefile b/docs/Makefile
@@ -1,8 +1,8 @@
-MAJOR_VERSION?=4
+MAJOR_VERSION?=5
 TAG?=20-alpine
 CONTAINER?=$(shell basename $(dir $(CURDIR)))-v${MAJOR_VERSION}-docs
 DOCS_DEV_PORT?=400${MAJOR_VERSION}
-DOCS_DEST?=../../../sites/nystudio107/web/docs/twig-profiler/v4
+DOCS_DEST?=../../../sites/nystudio107/web/docs/twig-profiler
 IMAGE_INFO=$(shell docker image inspect $(CONTAINER):$(TAG))
 IMAGE_NAME=${CONTAINER}:${TAG}
 DOCKER_RUN=docker container run --rm -it -v "${CURDIR}":/app

diff --git a/docs/docs/.vitepress/config.ts b/docs/docs/.vitepress/config.ts
@@ -3,7 +3,7 @@ import {defineConfig} from 'vitepress'
 export default defineConfig({
   title: 'Twig Profiler Plugin',
   description: 'Documentation for the Twig Profiler plugin',
-  base: '/docs/twig-profiler/v4/',
+  base: '/docs/twig-profiler/v5/',
   lang: 'en-US',
   head: [
     ['meta', {content: 'https://github.com/nystudio107', property: 'og:see_also',}],
@@ -18,15 +18,15 @@ export default defineConfig({
     ],
     logo: '/img/plugin-logo.svg',
     editLink: {
-      pattern: 'https://github.com/nystudio107/craft-twigprofiler/edit/develop-v4/docs/docs/:path',
+      pattern: 'https://github.com/nystudio107/craft-twigprofiler/edit/develop-v5/docs/docs/:path',
       text: 'Edit this page on GitHub'
     },
     algolia: {
       appId: 'V60OC8MPVK',
       apiKey: 'f0f7f91f8388d5b8d8c7f78dbcc4ea97',
       indexName: 'nystudio107-twig-profiler',
       searchParameters: {
-        facetFilters: ["version:v4"],
+        facetFilters: ["version:v5"],
       },
     },
     lastUpdatedText: 'Last Updated',
@@ -37,9 +37,9 @@ export default defineConfig({
       {text: 'Changelog', link: 'https://nystudio107.com/plugins/twig-profiler/changelog'},
       {text: 'Issues', link: 'https://github.com/nystudio107/craft-twigprofiler/issues'},
       {
-        text: 'v4', items: [
-          {text: 'v5', link: 'https://nystudio107.com/docs/twig-profiler/'},
-          {text: 'v4', link: '/'},
+        text: 'v5', items: [
+          {text: 'v5', link: '/'},
+          {text: 'v4', link: 'https://nystudio107.com/docs/twig-profiler/v4/'},
           {text: 'v1', link: 'https://nystudio107.com/docs/twig-profiler/v1/'},
         ],
       },

diff --git a/docs/docs/index.md b/docs/docs/index.md
@@ -1,14 +1,14 @@
-[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/nystudio107/craft-twigprofiler/badges/quality-score.png?b=v4)](https://scrutinizer-ci.com/g/nystudio107/craft-twigprofiler/?branch=v4) [![Code Coverage](https://scrutinizer-ci.com/g/nystudio107/craft-twigprofiler/badges/coverage.png?b=v4)](https://scrutinizer-ci.com/g/nystudio107/craft-twigprofiler/?branch=v4) [![Build Status](https://scrutinizer-ci.com/g/nystudio107/craft-twigprofiler/badges/build.png?b=v4)](https://scrutinizer-ci.com/g/nystudio107/craft-twigprofiler/build-status/v4) [![Code Intelligence Status](https://scrutinizer-ci.com/g/nystudio107/craft-twigprofiler/badges/code-intelligence.svg?b=v4)](https://scrutinizer-ci.com/code-intelligence)
+[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/nystudio107/craft-twigprofiler/badges/quality-score.png?b=v5)](https://scrutinizer-ci.com/g/nystudio107/craft-twigprofiler/?branch=v5) [![Code Coverage](https://scrutinizer-ci.com/g/nystudio107/craft-twigprofiler/badges/coverage.png?b=v5)](https://scrutinizer-ci.com/g/nystudio107/craft-twigprofiler/?branch=v5) [![Build Status](https://scrutinizer-ci.com/g/nystudio107/craft-twigprofiler/badges/build.png?b=v5)](https://scrutinizer-ci.com/g/nystudio107/craft-twigprofiler/build-status/v5) [![Code Intelligence Status](https://scrutinizer-ci.com/g/nystudio107/craft-twigprofiler/badges/code-intelligence.svg?b=v5)](https://scrutinizer-ci.com/code-intelligence)
 
-# Twig Profiler plugin for Craft CMS 4.x
+# Twig Profiler plugin for Craft CMS 5.x
 
 Twig Profiler allows you to profile sections of your Twig templates, and see the resulting timings in the Yii2 Debug Toolbar
 
 ![Screenshot](./resources/img/plugin-logo.png)
 
 ## Requirements
 
-This plugin requires Craft CMS 4.0.0 or later.
+This plugin requires Craft CMS 5.0.0 or later.
 
 ## Installation