Release 3.1.0

.eslintrc

@@ -6,5 +6,9 @@
 	},
 	"rules": {
 		"@wordpress/i18n-text-domain": [ "error", { "allowedTextDomain": [ "wp-parsely" ] } ]
+	},
+	"globals": {
+		// Page variable for Puppeteer tests
+		"page": true
 	}
 }

.github/ISSUE_TEMPLATE/release-template.md

@@ -12,13 +12,17 @@ labels: 'Type: Maintenance'
 
 PR for tracking changes for the X.Y.Z release. Target release date: DOW DD MMMM YYYY.
 
-- [ ] Merge any outstanding PRs due for this release.
-- [ ] Add/Update changelog for this release: PR #XXX
-- [ ] Add commit/PR which increases version numbers in the README, plugin bootstrap file, and in the `test_class_version` test in `tests/class-all-test.php`. 
+- [ ] Merge any outstanding PRs due for this release to `develop`.
+- [ ] Notify stakeholders of an upcoming release.
+- [ ] Add [PR](https://github.com/Parsely/wp-parsely/pull/XXX) against `develop` which:
+  - Increases version numbers in the README, plugin bootstrap file `wp-parsely.php`, and `package.json`.
+  - Adds or updates the changelog for the release.
 - [ ] Merge this PR.
-- [ ] Add signed release tag against `trunk`.
+- [ ] Create a branch from `trunk` named `release-x.y.z`. Merge `develop` into that branch. Open a PR from `release-x.y.z` to `trunk` named _Release x.y.z_.
+- [ ] Add signed release tag against `trunk` using GitHub's UI.
 - [ ] Close the current milestone.
 - [ ] Open a new milestone for the next release.
 - [ ] If any open PRs/issues which were milestoned for this release do not make it into the release, update their milestone.
+- [ ] Sync changes from `trunk` to `develop`. Update versions in `develop` to be `x.y.z-alpha` (where `x.y.z` is the next milestone).
 - [ ] Write a Lobby post.
 - [ ] Write an internal P2 post.

.github/dependabot.yml

@@ -8,11 +8,15 @@ updates:
       interval: 'daily'
 
   - package-ecosystem: 'composer'
+    reviewers:
+      - 'Parsely/wp-parsely'
     directory: '/'
     schedule:
       interval: 'daily'
 
   - package-ecosystem: 'github-actions'
+    reviewers:
+      - 'Parsely/wp-parsely'
     directory: '/'
     schedule:
       interval: 'daily'

.github/pull_request_template.md

@@ -12,10 +12,4 @@
 <!--- Include details of your testing environment, and the tests you ran to -->
 <!--- see how your change affects other areas of the code, etc. -->
 
-## Screenshots (if appropriate):
-
-## Types of changes
-<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
-- [ ] Bug fix (non-breaking change which fixes an issue)
-- [ ] New feature (non-breaking change which adds functionality)
-- [ ] Breaking change (fix or feature that would cause existing functionality to change)
+## Screenshots (if appropriate)

.github/workflows/codeql-analysis.yml

@@ -13,10 +13,16 @@ on:
   schedule:
     - cron: '27 20 * * 2'
 
+# Cancels all previous workflow runs for the same branch that have not yet completed.
+concurrency:
+  # The concurrency group contains the workflow name and the branch name.
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
 jobs:
   analyze:
     name: Analyze
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-20.04
     permissions:
       actions: read
       contents: read

.github/workflows/cs-lint.yml

@@ -10,10 +10,16 @@ on:
   # Allow manually triggering the workflow.
   workflow_dispatch:
 
+# Cancels all previous workflow runs for the same branch that have not yet completed.
+concurrency:
+  # The concurrency group contains the workflow name and the branch name.
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
 jobs:
   checkcs:
     name: 'Basic CS and QA checks'
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-20.04
 
     env:
       XMLLINT_INDENT: '	'
@@ -42,16 +48,16 @@ jobs:
       # Validate the composer.json file.
       # @link https://getcomposer.org/doc/03-cli.md#validate
       - name: Validate Composer installation
-        run: composer validate --no-check-all --strict
+        run: composer validate --no-check-all --strict --no-interaction
 
       # Install dependencies and handle caching in one go.
       # @link https://github.com/marketplace/actions/install-composer-dependencies
       - name: Install Composer dependencies
-        uses: ramsey/composer-install@v1
+        uses: ramsey/composer-install@v2
 
       # Lint PHP.
       - name: Lint PHP against parse errors
-        run: composer lint-ci | cs2pr
+        run: composer lint-ci --no-interaction | cs2pr
 
       # Needed as runs-on: system doesn't have xml-lint by default.
       # @link https://github.com/marketplace/actions/xml-lint
@@ -69,7 +75,7 @@ jobs:
 
       # Check the code-style consistency of the PHP files.
       - name: Check PHP code style
-        run: vendor/bin/phpcs --report-full --report-checkstyle=./phpcs-report.xml
+        run: composer cs -- --report-full --report-checkstyle=./phpcs-report.xml
 
       - name: Show PHPCS results in PR
         run: cs2pr ./phpcs-report.xml

.github/workflows/deploy.yml

@@ -5,7 +5,7 @@ on:
 jobs:
   tag:
     name: New tag
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-20.04
     steps:
       - uses: actions/checkout@v2
       - name: Build # Remove or modify this step as needed

.github/workflows/e2e-tests.yml

@@ -17,7 +17,7 @@ concurrency:
 jobs:
   test:
     name: e2e against WordPress latest
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-20.04
 
     steps:
       - name: Checkout code

.github/workflows/integration-tests.yml

@@ -7,16 +7,17 @@ on:
     paths-ignore:
       - '**.md'
   pull_request:
-  # Allow manually triggering the workflow.
-  workflow_dispatch:
+
+# Cancels all previous workflow runs for the same branch that have not yet completed.
+concurrency:
+  # The concurrency group contains the workflow name and the branch name.
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
 
 jobs:
   test:
     name: PHP ${{ matrix.php }}
-    # ubuntu-20.04 / ubuntu-latest includes MySQL 8, which has issues with PHP < 7.4. Has PHP 7.4-8.0
-    # ubuntu-18.04 includes PHP versions 7.1-8.0.
-    # See https://setup-php.com/i/452
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-20.04
 
     env:
       WP_VERSION: latest
@@ -45,9 +46,9 @@ jobs:
           - php: '8.1'
             coverage: none
             experimental: false
-          - php: '8.2'
-            coverage: none
-            experimental: true
+          # - php: '8.2'
+          #  coverage: none
+          #  experimental: true
       fail-fast: false
     continue-on-error: ${{ matrix.experimental }}
     steps:
@@ -68,25 +69,29 @@ jobs:
       - name: Setup Problem Matchers for PHPUnit
         run: echo "::add-matcher::${{ runner.tool_cache }}/phpunit.json"
 
-      - name: Install Composer dependencies for PHP < 8.2
-        if: ${{ matrix.php < 8.2 }}
-        uses: ramsey/composer-install@v1
+      - name: Install Composer dependencies
+        uses: ramsey/composer-install@v2
 
-      - name: Install Composer dependencies for PHP >= 8.2
-        if: ${{ matrix.php >= 8.2 }}
-        uses: ramsey/composer-install@v1
-        with:
-          composer-options: --ignore-platform-reqs
+      # - name: Install Composer dependencies for PHP >= 8.2
+      #  if: ${{ matrix.php >= 8.2 }}
+      #  uses: ramsey/composer-install@v2
+      #  with:
+      #    composer-options: --ignore-platform-reqs
 
       - name: Start MySQL Service
         run: sudo systemctl start mysql.service
 
+      - name: Setting mysql_native_password for PHP <= 7.3
+        if: ${{ matrix.php <= 7.3 }}
+        run: mysql -u root -proot -e "ALTER USER 'root'@'localhost' IDENTIFIED WITH mysql_native_password BY 'root';"
+
       - name: Prepare environment for integration tests
-        run: composer prepare-ci
+        run: composer prepare-ci --no-interaction
 
       - name: Run integration tests (single site)
         if: ${{ matrix.php != 8.0 }}
-        run: composer testwp
+        run: composer testwp --no-interaction
+
       - name: Run integration tests (multisite site with code coverage)
         if: ${{ matrix.php == 8.0 }}
-        run: composer coveragewp-ci
+        run: composer coveragewp-ci --no-interaction

.github/workflows/node.js.yml

@@ -11,9 +11,15 @@ on:
       - '**/*[tj]sx?'
       - package*.json
 
+# Cancels all previous workflow runs for the same branch that have not yet completed.
+concurrency:
+  # The concurrency group contains the workflow name and the branch name.
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
 jobs:
   build:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-20.04
 
     strategy:
       matrix:
@@ -31,6 +37,15 @@ jobs:
       - name: Install JavaScript dependencies
         run: npm ci
 
+      - name: Lint CSS code
+        run: npm run lint:css
+
+      - name: Lint package.json file
+        run: npm run lint:pkg-json
+
+      - name: Lint JS code
+        run: npm run lint:js
+
       - name: Build application
         run: npm run build
 

.github/workflows/unit-tests.yml

@@ -10,13 +10,16 @@ on:
   # Allow manually triggering the workflow.
   workflow_dispatch:
 
+# Cancels all previous workflow runs for the same branch that have not yet completed.
+concurrency:
+  # The concurrency group contains the workflow name and the branch name.
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
 jobs:
   test:
     name: PHP ${{ matrix.php }}
-    # ubuntu-20.04 / ubuntu-latest includes MySQL 8, which has issues with PHP < 7.4. Has PHP 7.4-8.0
-    # ubuntu-18.04 includes PHP versions 7.1-8.0.
-    # See https://setup-php.com/i/452
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-20.04
 
     env:
       WP_VERSION: latest
@@ -70,13 +73,13 @@ jobs:
 
       - name: Install Composer dependencies for PHP < 8.2
         if: ${{ matrix.php < 8.2 }}
-        uses: ramsey/composer-install@v1
+        uses: ramsey/composer-install@v2
 
       - name: Install Composer dependencies for PHP >= 8.2
         if: ${{ matrix.php >= 8.2 }}
-        uses: ramsey/composer-install@v1
+        uses: ramsey/composer-install@v2
         with:
           composer-options: --ignore-platform-reqs
 
       - name: Run unit tests
-        run: composer test
+        run: composer test --no-interaction

.husky/pre-commit

@@ -0,0 +1,5 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npm run lint
+composer cs

CHANGELOG.md

@@ -5,6 +5,62 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [3.1.0] 2022-01-21
+
+The 3.1.0 release is a minor release for the plugin that does not introduce any breaking changes coming from the 3.0 branch. This version's primary focus is adding support for WordPress decoupled architectures and a revamped settings page. We have also worked hard on refining our code, testing, and delivery process.
+
+The Parse.ly plugin now hooks into the WordPress REST API to provide content metadata in a format that's easy for a variety of client applications to consume. A `parsely` field containing the metadata is now rendered in the tracked objects (e.g., `post` and `page`). No new endpoint is introduced. This behavior can be disabled using a filter. Please refer to the plugin's README file for more details. Note that the tracking script must still be inserted manually in the decoupled front-end or otherwise loaded for your site.
+
+### Added
+
+- Decoupled support. [#489](https://github.com/Parsely/wp-parsely/pull/489) [#500](https://github.com/Parsely/wp-parsely/pull/500)
+- Revamped wp-admin settings page, divided in sections. [#518](https://github.com/Parsely/wp-parsely/pull/518)
+- Parse.ly stats button on admin bar. [#569](https://github.com/Parsely/wp-parsely/pull/569)
+- Show error in settings page when duplicated tracking is selected. [#543](https://github.com/Parsely/wp-parsely/pull/543)
+- Instructions for local development. [#525](https://github.com/Parsely/wp-parsely/pull/525)
+- Local developer environment logs command. [#532](https://github.com/Parsely/wp-parsely/pull/532)
+- Husky-based git commit hooks to enforce linting rules prior to commit. [#538](https://github.com/Parsely/wp-parsely/pull/538)
+- Linting for JavaScript and CSS files. [#527](https://github.com/Parsely/wp-parsely/pull/527)
+- Types to function arguments in GetCurrentUrlTest. [#504](https://github.com/Parsely/wp-parsely/pull/504)
+- End-to-end test to verify if scripts are rendered in the front-end. [#528](https://github.com/Parsely/wp-parsely/pull/528)
+- Concurrency to CI configuration and Composer tweaks. [#559](https://github.com/Parsely/wp-parsely/pull/559)
+- Explicit dependabot reviewers on GitHub. [#526](https://github.com/Parsely/wp-parsely/pull/526)
+- WordPress.org banner images. [#581](https://github.com/Parsely/wp-parsely/pull/581)
+- PHPStan static analysis tool. [#590](https://github.com/Parsely/wp-parsely/pull/590)
+
+### Changed
+
+- Hiding _Disable AMP_ field on settings page when the AMP plugin is not enabled. [#519](https://github.com/Parsely/wp-parsely/pull/519)
+- Use built-in WordPress submit button instead of custom one in the settings page. [#513](https://github.com/Parsely/wp-parsely/pull/513)
+- Improved wp-admin settings page help texts. [#552](https://github.com/Parsely/wp-parsely/pull/552)
+- `@wordpress/scripts` bumped from 19.2.1 to 19.2.3. [#503](https://github.com/Parsely/wp-parsely/pull/503) [#603](https://github.com/Parsely/wp-parsely/pull/603)
+- `prettier` bumped from 2.4.1 to 2.5.0. [#509](https://github.com/Parsely/wp-parsely/pull/509)
+- `concurrently` bumped from 6.4.0 to 6.5.1. [#551](https://github.com/Parsely/wp-parsely/pull/551)
+- Ubuntu bumped from 18.04 to 20.04 on CI tests. [#445](https://github.com/Parsely/wp-parsely/pull/445)
+- Unit and Integration tests run in random order. [#511](https://github.com/Parsely/wp-parsely/pull/511)
+- Correct Parse.ly spelling in tests comments. [#561](https://github.com/Parsely/wp-parsely/pull/561)
+- Minor amendments on the documentation. [#514](https://github.com/Parsely/wp-parsely/pull/514)
+- Updated release process guidelines. [#567](https://github.com/Parsely/wp-parsely/pull/567)
+- Removed checkboxes from GitHub's PR template. [#512](https://github.com/Parsely/wp-parsely/pull/512)
+- Improved JS scripts integration tests. [#557](https://github.com/Parsely/wp-parsely/pull/557)
+- Source code linting violations (PHPCS with `--serverity=1`). [#544](https://github.com/Parsely/wp-parsely/pull/544)
+- WordPress.org screenshots for settings page. [#574](https://github.com/Parsely/wp-parsely/pull/574)
+
+### Fixed
+
+- Incorrect type errors. [#607](https://github.com/Parsely/wp-parsely/pull/607)
+- Undefined index error on settings page. [#536](https://github.com/Parsely/wp-parsely/pull/536)
+- Source the correct asset for the Recommendations Widget. [#545](https://github.com/Parsely/wp-parsely/pull/545)
+- End-to-end tests in CI (GitHub Actions). [#521](https://github.com/Parsely/wp-parsely/pull/521)
+
+### Removed
+
+- Plugin version number being printed in front-end's HTML source code. [#502](https://github.com/Parsely/wp-parsely/pull/502)
+- Custom CSS on wp-admin settings page. [#496](https://github.com/Parsely/wp-parsely/pull/496)
+- `migrate_old_fields` private function from Recommended Widget. [#599](https://github.com/Parsely/wp-parsely/pull/599)
+- PHP 8.2 from CI tests. [#523](https://github.com/Parsely/wp-parsely/pull/523)
+- Custom end-to-end Docker image. [#524] (https://github.com/Parsely/wp-parsely/pull/524)
+
 ## [3.0.4] - 2022-01-17
 
 ### Changed
@@ -446,6 +502,7 @@ If you are using the plugin without any code-level customizations (for instance,
 - Initial version.
 - Add support for parsely-page and JavaScript on home page and published pages and posts as well as archive pages (date/author/category/tag).
 
+[3.1.0]: https://github.com/Parsely/wp-parsely/compare/3.0.4...3.1.0
 [3.0.4]: https://github.com/Parsely/wp-parsely/compare/3.0.3...3.0.4
 [3.0.3]: https://github.com/Parsely/wp-parsely/compare/3.0.2...3.0.3
 [3.0.2]: https://github.com/Parsely/wp-parsely/compare/3.0.1...3.0.2