Skip to content

Commit

Permalink
Add compatibility with Craft 5, change license
Browse files Browse the repository at this point in the history
  • Loading branch information
bencroker committed Mar 22, 2024
1 parent 934ec96 commit 45cadb8
Show file tree
Hide file tree
Showing 18 changed files with 297 additions and 154 deletions.
1 change: 0 additions & 1 deletion .gitattributes
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
/.gitattributes export-ignore
/.github/ export-ignore
/.gitignore export-ignore
/codeception.yml export-ignore
/ecs.php export-ignore
/phpstan.neon export-ignore

Expand Down
42 changes: 42 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
name: Bug Report
description: Create a bug report for this plugin.
labels:
- bug
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to submit a bug report! To ensure this hasn’t already been reported, please first search existing issues.
To rule out that this isn’t a setup or configuration issue, please read the docs.
If you still believe you’ve found a bug, please provide a clear and concise description, including:
- What is happening and what you expected to happen.
- Steps to reproduce the issue.
- Screenshots, if applicable.
- type: textarea
id: body
attributes:
label: Bug Report
description: Please provide a clear and concise description of the bug.
validations:
required: true
- type: input
id: pluginVersion
attributes:
label: Plugin Version
description: Provide the plugin version that this relates to, ideally the latest version.
validations:
required: true
- type: input
id: craftVersion
attributes:
label: Craft CMS Version
description: Provide the version of Craft that is installed.
validations:
required: true
- type: input
id: phpVersion
attributes:
label: PHP Version
description: Provide the PHP version, if applicable.
14 changes: 0 additions & 14 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: false
25 changes: 25 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
name: Feature Request
description: Suggest a new feature for this plugin.
labels:
- enhancement
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to submit a feature request! To ensure this isn’t already on our radar, please first search existing issues.
If you still believe you have a new suggestion, please provide a clear and concise description, including:
- What problem you believe your feature request can solve.
- Any alternative solutions or features you have already considered.
- type: textarea
id: body
attributes:
label: Feature Request
description: Please provide a clear and concise suggestion for a feature.
validations:
required: true
- type: input
id: pluginVersion
attributes:
label: Plugin Version
description: Provide the plugin version that this relates to, ideally the latest version.
12 changes: 0 additions & 12 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

10 changes: 0 additions & 10 deletions .github/ISSUE_TEMPLATE/support-request.md

This file was deleted.

23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/support-request.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
name: Support Request
description: Ask a question about this plugin.
labels:
- question
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to submit a support request! To ensure your question hasn’t already been asked and answered, please first search existing issues.
If your question is still unanswered, please provide a clear and concise description. Note that we are diligent about documentation, so please check whether your question is answered by the plugin docs before submitting.
- type: textarea
id: body
attributes:
label: Support Request
description: Please provide a clear and concise question.
validations:
required: true
- type: input
id: pluginVersion
attributes:
label: Plugin Version
description: Provide the plugin version that this relates to, ideally the latest version.
41 changes: 41 additions & 0 deletions .github/workflows/code-analysis.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
name: Code Analysis

on:
pull_request: null
push:
branches:
- develop
- v3
workflow_dispatch:
permissions:
contents: read
jobs:
code_analysis:
strategy:
fail-fast: false
matrix:
actions:
- name: 'PHPStan'
run: composer phpstan
- name: 'Coding Standards'
run: composer fix-cs
name: ${{ matrix.actions.name }}
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Cache Composer dependencies
uses: actions/cache@v4
with:
path: /tmp/composer-cache
key: ${{ runner.os }}-${{ hashFiles('**/composer.lock') }}
- name: Setup PHP
id: setup-php
uses: shivammathur/setup-php@v2
with:
php-version: 8.2
extensions: 'ctype,curl,dom,iconv,imagick,intl,json,mbstring,openssl,pcre,pdo,reflection,spl,zip'
ini-values: post_max_size=256M, max_execution_time=180, memory_limit=512M
tools: composer:v2
- name: Install Composer dependencies
run: composer install --no-interaction --no-ansi --no-progress
- run: ${{ matrix.actions.run }}
21 changes: 21 additions & 0 deletions .github/workflows/create-release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
name: Create Release
run-name: Create release for ${{ github.event.client_payload.version }}

on:
repository_dispatch:
types:
- craftcms/new-release

jobs:
build:
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- uses: ncipollo/release-action@v1
with:
body: ${{ github.event.client_payload.notes }}
makeLatest: ${{ github.event.client_payload.latest }}
name: ${{ github.event.client_payload.version }}
prerelease: ${{ github.event.client_payload.prerelease }}
tag: ${{ github.event.client_payload.tag }}
15 changes: 5 additions & 10 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,11 @@
# Release Notes for Elements Panel

## 2.0.0 - 2022-05-04
- Added compatibility with Craft 4.
## 3.0.0-beta.1 - 2024-03-21

## 1.1.1 - 2020-10-30
### Added
- Added a field handle column to the eager-loading panel.

## 1.1.0 - 2020-06-29
### Added
- Added support for eager-loading matrix fields.
- Added support for eager-loading relation fields within matrix fields ([#3](https://github.com/putyourlightson/craft-elements-panel/issues/3)).
- Added compatibility with Craft 5.

### Changed

## 1.0.0 - 2020-06-11
- Initial release.
- Changed the license from MIT to a proprietary license.
39 changes: 36 additions & 3 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,40 @@
Copyright © PutYourLightsOn

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
Permission is hereby granted to any person obtaining a copy of this software
(the “Software”) to use, copy, modify, merge, publish and/or distribute copies
of the Software, and to permit persons to whom the Software is furnished to do
so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
1. **Don’t plagiarize.** The above copyright notice and this license shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
2. **Don’t use the same license on more than one project.** Each licensed copy
of the Software shall be actively installed in no more than one production
environment at a time.

3. **Don’t mess with the licensing features.** Software features related to
licensing shall not be altered or circumvented in any way, including (but
not limited to) license validation, payment prompts, feature restrictions,
and update eligibility.

4. **Pay up.** Payment shall be made immediately upon receipt of any notice,
prompt, reminder, or other message indicating that a payment is owed.

5. **Follow the law.** All use of the Software shall not violate any applicable
law or regulation, nor infringe the rights of any other person or entity.

Failure to comply with the foregoing conditions will automatically and
immediately result in termination of the permission granted hereby. This
license does not include any right to receive updates to the Software or
technical support. Licensees bear all risk related to the quality and
performance of the Software and any modifications made or obtained to it,
including liability for actual and consequential harm, such as loss or
corruption of data, and any necessary service, repair, or correction.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES, OR OTHER
LIABILITY, INCLUDING SPECIAL, INCIDENTAL AND CONSEQUENTIAL DAMAGES, WHETHER IN
AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,11 @@ Learn more and read the documentation at [putyourlightson.com/plugins/elements-p

## License

This plugin is licensed for free under the MIT License.
This plugin requires a free commercial license available through the [Craft Plugin Store](https://plugins.craftcms.com/elements-panel).

## Requirements

This plugin requires [Craft CMS](https://craftcms.com/) 3.0.0 or later, or 4.0.0 or later.
This plugin requires [Craft CMS](https://craftcms.com/) 3.0.0 or later, or 4.0.0 or later, or 5.0.0 or later.

## Installation

Expand Down
72 changes: 45 additions & 27 deletions composer.json
Original file line number Diff line number Diff line change
@@ -1,30 +1,48 @@
{
"name": "putyourlightson/craft-elements-panel",
"description": "Adds an Elements and an Eager-Loading panel to the debug toolbar.",
"version": "2.0.0",
"type": "craft-plugin",
"license": "mit",
"require": {
"php": "^8.0.2",
"craftcms/cms": "^4.0.0"
},
"autoload": {
"psr-4": {
"putyourlightson\\elementspanel\\": "src/"
}
},
"support": {
"docs": "https://putyourlightson.com/plugins/elements-panel",
"source": "https://github.com/putyourlightson/craft-elements-panel",
"issues": "https://github.com/putyourlightson/craft-elements-panel/issues"
},
"extra": {
"name": "Elements Panel",
"handle": "elements-panel",
"developer": "PutYourLightsOn",
"developerUrl": "https://putyourlightson.com/",
"documentationUrl": "https://putyourlightson.com/plugins/elements-panel",
"changelogUrl": "https://raw.githubusercontent.com/putyourlightson/craft-elements-panel/v2/CHANGELOG.md",
"class": "putyourlightson\\elementspanel\\ElementsPanel"
"name": "putyourlightson/craft-elements-panel",
"description": "Adds an Elements and an Eager-Loading panel to the debug toolbar.",
"version": "3.0.0-beta.1",
"type": "craft-plugin",
"license": "proprietary",
"require": {
"php": "^8.2",
"craftcms/cms": "^5.0.0-beta.1"
},
"require-dev": {
"craftcms/ecs": "dev-main",
"craftcms/phpstan": "dev-main"
},
"autoload": {
"psr-4": {
"putyourlightson\\elementspanel\\": "src/"
}
},
"scripts": {
"phpstan": "phpstan --ansi --memory-limit=1G",
"check-cs": "ecs check --ansi",
"fix-cs": "ecs check --fix --ansi"
},
"config": {
"allow-plugins": {
"craftcms/plugin-installer": true,
"pestphp/pest-plugin": true,
"yiisoft/yii2-composer": true
},
"optimize-autoloader": true,
"sort-packages": true
},
"support": {
"docs": "https://putyourlightson.com/plugins/elements-panel",
"source": "https://github.com/putyourlightson/craft-elements-panel",
"issues": "https://github.com/putyourlightson/craft-elements-panel/issues"
},
"extra": {
"name": "Elements Panel",
"handle": "elements-panel",
"developer": "PutYourLightsOn",
"developerUrl": "https://putyourlightson.com/",
"documentationUrl": "https://putyourlightson.com/plugins/elements-panel",
"changelogUrl": "https://raw.githubusercontent.com/putyourlightson/craft-elements-panel/v3/CHANGELOG.md",
"class": "putyourlightson\\elementspanel\\ElementsPanel"
}
}
3 changes: 1 addition & 2 deletions ecs.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,10 @@
use Symplify\EasyCodingStandard\Config\ECSConfig;

return static function(ECSConfig $ecsConfig): void {
$ecsConfig->parallel();
$ecsConfig->paths([
__DIR__ . '/src',
__FILE__,
]);

$ecsConfig->parallel();
$ecsConfig->sets([SetList::CRAFT_CMS_4]);
};
Loading

0 comments on commit 45cadb8

Please sign in to comment.