feat: Update for v5

nystudio107 · Oct 7, 2024 · 58c93bb · 58c93bb
1 parent ac6223d
commit 58c93bb
Show file tree

Hide file tree

Showing 9 changed files with 27 additions and 55 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: /disqus/v4/
+  DOCS_DEST_DIR: /disqus/
 on:
   push:
     branches:
-      - v4
+      - v5
     paths:
       - 'docs/**'
   pull_request:
     branches:
-      - v4
+      - v5
     paths:
       - 'docs/**'
   workflow_dispatch:

diff --git a/.github/workflows/code-analysis.yaml b/.github/workflows/code-analysis.yaml
@@ -4,7 +4,7 @@ on:
   pull_request: null
   push:
     branches:
-      - develop-v4
+      - develop-v5
   workflow_dispatch:
 permissions:
   contents: read
@@ -14,11 +14,9 @@ jobs:
       fail-fast: false
       matrix:
         actions:
-          -
-            name: 'PHPStan'
+          - name: 'PHPStan'
             run: composer phpstan
-          -
-            name: 'Coding Standards'
+          - name: 'Coding Standards'
             run: composer fix-cs
     name: ${{ matrix.actions.name }}
     runs-on: ubuntu-latest

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,29 +1,5 @@
 # Disqus Changelog
 
-## 4.0.1 - UNRELEASED
+## 5.0.0 - UNRELEASED
 ### Added
-* Added a **Lazy Load Disqus** settings option, so you can control whether the Disqus JavaScript is lazily loaded or not ([#8](https://github.com/nystudio107/craft-disqus/issues/8))
-* Added the ability to pass in additional attributes that will be added to the rendered Disqus `<script>` tag ([#28](https://github.com/nystudio107/craft-disqus/issues/28))
-* Added the ability to use environment variables / aliases for the additional settings ([#15](https://github.com/nystudio107/craft-disqus/pull/15/))
-* Add `phpstan` and `ecs` code linting
-* Add `code-analysis.yaml` GitHub action
-
-### Fixed
-* Fixed an issue where avatars wouldn't display ([#37](https://github.com/nystudio107/craft-disqus/issues/37))
-* Fixed an issue where incorrect headers were sent if the API key was an environment variable or alias ([#15](https://github.com/nystudio107/craft-disqus/pull/15/))
-
-## 4.0.0 - 2022.06.01
-### Added
-* Initial Craft CMS 4 release
-
-## 4.0.0-beta.3 - 2022.04.11
-### Fixed
-* Fixed an issue where the Disqus tag was not output as HTML, but rather a plain text via the Twig Extension
-
-## 4.0.0-beta.2 - 2022.04.11
-### Fixed
-* Fixed an issue where the Disqus tag was not output as HTML, but rather a plain text
-
-## 4.0.0-beta.1 - 2022.03.25
-### Added
-* Initial Craft CMS 4 compatibility
+* Initial Craft CMS 5 release
diff --git a/Makefile b/Makefile
@@ -1,4 +1,4 @@
-MAJOR_VERSION?=4
+MAJOR_VERSION?=5
 PLUGINDEV_PROJECT_DIR?=/Users/andrew/webdev/sites/plugindev/cms_v${MAJOR_VERSION}/
 VENDOR?=nystudio107
 PROJECT_PATH?=${VENDOR}/$(shell basename $(CURDIR))

diff --git a/README.md b/README.md
@@ -1,16 +1,14 @@
-[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/nystudio107/craft-disqus/badges/quality-score.png?b=v4)](https://scrutinizer-ci.com/g/nystudio107/craft-disqus/?branch=v4) [![Code Coverage](https://scrutinizer-ci.com/g/nystudio107/craft-disqus/badges/coverage.png?b=v4)](https://scrutinizer-ci.com/g/nystudio107/craft-disqus/?branch=v4) [![Build Status](https://scrutinizer-ci.com/g/nystudio107/craft-disqus/badges/build.png?b=v4)](https://scrutinizer-ci.com/g/nystudio107/craft-disqus/build-status/v4) [![Code Intelligence Status](https://scrutinizer-ci.com/g/nystudio107/craft-disqus/badges/code-intelligence.svg?b=v4)](https://scrutinizer-ci.com/code-intelligence)
+[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/nystudio107/craft-disqus/badges/quality-score.png?b=v5)](https://scrutinizer-ci.com/g/nystudio107/craft-disqus/?branch=v5) [![Code Coverage](https://scrutinizer-ci.com/g/nystudio107/craft-disqus/badges/coverage.png?b=v5)](https://scrutinizer-ci.com/g/nystudio107/craft-disqus/?branch=v5) [![Build Status](https://scrutinizer-ci.com/g/nystudio107/craft-disqus/badges/build.png?b=v5)](https://scrutinizer-ci.com/g/nystudio107/craft-disqus/build-status/v5) [![Code Intelligence Status](https://scrutinizer-ci.com/g/nystudio107/craft-disqus/badges/code-intelligence.svg?b=v5)](https://scrutinizer-ci.com/code-intelligence)
 
-# Disqus plugin for Craft CMS 4.x
+# Disqus plugin for Craft CMS 5.x
 
 Integrates the Disqus commenting system into Craft CMS websites, including Single Sign On (SSO) and custom login/logout URLs
 
 ![Screenshot](./docs/docs/resources/img/plugin-logo.png)
 
-Related: [Disqus for Craft 2.x](https://github.com/nystudio107/disqus)
-
 ## 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-disqus",
   "description": "Integrates the Disqus commenting system into Craft CMS websites, including Single Sign On (SSO) and custom login/logout URLs",
   "type": "craft-plugin",
-  "version": "4.0.1",
+  "version": "5.0.0",
   "keywords": [
     "craft",
     "cms",
@@ -23,7 +23,7 @@
     }
   ],
   "require": {
-    "craftcms/cms": "^4.0.0"
+    "craftcms/cms": "^5.0.0"
   },
   "require-dev": {
     "craftcms/ecs": "dev-main",

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/disqus/v4
+DOCS_DEST?=../../../sites/nystudio107/web/docs/disqus
 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
@@ -1,9 +1,9 @@
 import {defineConfig} from 'vitepress'
 
 export default defineConfig({
-  title: 'Vite Plugin',
-  description: 'Documentation for the Vite plugin',
-  base: '/docs/disqus/v4/',
+  title: 'Disqus Plugin',
+  description: 'Documentation for the Disqus plugin',
+  base: '/docs/disqus/',
   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-disqus/edit/develop-v4/docs/docs/:path',
+      pattern: 'https://github.com/nystudio107/craft-disqus/edit/develop-v5/docs/docs/:path',
       text: 'Edit this page on GitHub'
     },
     algolia: {
       appId: 'AE3HRUJFEW',
       apiKey: 'c5dcc2be096fff3a4714c3a877a056fa',
       indexName: 'disqus',
       searchParameters: {
-        facetFilters: ["version:v4"],
+        facetFilters: ["version:v5"],
       },
     },
     lastUpdatedText: 'Last Updated',
@@ -37,9 +37,9 @@ export default defineConfig({
       {text: 'Changelog', link: 'https://nystudio107.com/plugins/disqus/changelog'},
       {text: 'Issues', link: 'https://github.com/nystudio107/craft-disqus/issues'},
       {
-        text: 'v4', items: [
-          {text: 'v5', link: 'https://nystudio107.com/docs/disqus/'},
-          {text: 'v4', link: '/'},
+        text: 'v5', items: [
+          {text: 'v5', link: '/'},
+          {text: 'v4', link: 'https://nystudio107.com/docs/disqus/v4/'},
           {text: 'v1', link: 'https://nystudio107.com/docs/disqus/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-disqus/badges/quality-score.png?b=v4)](https://scrutinizer-ci.com/g/nystudio107/craft-disqus/?branch=v4) [![Code Coverage](https://scrutinizer-ci.com/g/nystudio107/craft-disqus/badges/coverage.png?b=v4)](https://scrutinizer-ci.com/g/nystudio107/craft-disqus/?branch=v4) [![Build Status](https://scrutinizer-ci.com/g/nystudio107/craft-disqus/badges/build.png?b=v4)](https://scrutinizer-ci.com/g/nystudio107/craft-disqus/build-status/v4) [![Code Intelligence Status](https://scrutinizer-ci.com/g/nystudio107/craft-disqus/badges/code-intelligence.svg?b=v4)](https://scrutinizer-ci.com/code-intelligence)
+[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/nystudio107/craft-disqus/badges/quality-score.png?b=v5)](https://scrutinizer-ci.com/g/nystudio107/craft-disqus/?branch=v5) [![Code Coverage](https://scrutinizer-ci.com/g/nystudio107/craft-disqus/badges/coverage.png?b=v5)](https://scrutinizer-ci.com/g/nystudio107/craft-disqus/?branch=v5) [![Build Status](https://scrutinizer-ci.com/g/nystudio107/craft-disqus/badges/build.png?b=v5)](https://scrutinizer-ci.com/g/nystudio107/craft-disqus/build-status/v5) [![Code Intelligence Status](https://scrutinizer-ci.com/g/nystudio107/craft-disqus/badges/code-intelligence.svg?b=v5)](https://scrutinizer-ci.com/code-intelligence)
 
-# Disqus plugin for Craft CMS 4.x
+# Disqus plugin for Craft CMS 5.x
 
 Integrates the Disqus commenting system into Craft 3 websites, including Single Sign On (SSO) and custom login/logout URLs
 
 ![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