Merge pull request #155 from Automattic/release/0.6.0

Author: GaryJones

.gitattributes

@@ -0,0 +1,25 @@
+# Exclude these files from release archives.
+
+# This will also make them unavailable when using Composer with `--prefer-dist`.
+
+# If you develop for this package using Composer, use `--prefer-source`.
+# https://www.reddit.com/r/PHP/comments/2jzp6k/i_dont_need_your_tests_in_my_production
+# https://blog.madewithlove.be/post/gitattributes/
+
+# They are also used when pushing to WordPress.org SVN using the
+# https://github.com/10up/action-wordpress-plugin-deploy GitHub Action.
+
+# Directories
+/.github                         export-ignore
+/.wordpress-org                  export-ignore
+/bin                             export-ignore
+/tests                           export-ignore
+
+# Files
+/.editorconfig                   export-ignore
+/.gitattributes                  export-ignore
+/.gitignore                      export-ignore
+/.phpcs.xml.dist                 export-ignore
+/CHANGELOG.md                    export-ignore
+/composer.json                   export-ignore
+/phpunit.xml.dist                export-ignore

.github/dependabot.yml

@@ -0,0 +1,19 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+
+  # Maintain dependencies for GitHub Actions
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"
+
+  # Maintain dependencies for Composer
+  - package-ecosystem: "composer"
+    directory: "/"
+    schedule:
+      interval: "daily"

.github/workflows/changelog.js

@@ -0,0 +1,52 @@
+// Replaces the `<!-- changelog -->` comment in the README.md with the release notes from GitHub.
+// Usage locally:
+//   TOKEN=... GITHUB_REPOSITORY='Automattic/ad-code-manager' node .github/workflows/changelog.js
+// Where TOKEN is a personal GitHub token that has access to the repo: https://github.com/settings/tokens
+// In a GitHub Workflow, TOKEN can be passed the special ${{ secrets.GITHUB_TOKEN }} token.
+
+const github = require('@actions/github');
+const semver = require('semver');
+const replace = require('replace-in-file');
+
+const filename = process.argv[2] || 'README.md';
+const myToken = process.env.TOKEN;
+
+async function run() {
+	const api = new github.GitHub(myToken);
+
+	const { data: releases } = await api.repos.listReleases( github.context.repo );
+
+	let published = releases.filter( release =>
+		! release.draft && ! release.prerelease
+	);
+
+	let sorted = published.sort( ( a, b ) =>
+		semver.rcompare( semver.coerce( a.tag_name ), semver.coerce( b.tag_name ) )
+	);
+
+	let changelog = sorted.reduce( ( changelog, release ) =>
+			`${changelog}
+
+### ${release.tag_name}
+
+${release.body}`
+		, '## Changelog' );
+
+	try {
+		const results = await replace( {
+			files: filename,
+			from: '<!-- changelog -->',
+			to: changelog,
+		} );
+
+		if ( results.filter( result => ! result.hasChanged ).length ) {
+			console.error( 'No replacements made' );
+			process.exitCode = 1;
+		}
+	} catch( exception ) {
+		console.error( exception );
+		process.exitCode = 1;
+	}
+}
+
+run();

.github/workflows/cs-lint.yml

@@ -1,4 +1,4 @@
-name: CS & Lint
+name: Lint PHP & XML
 
 on:
   # Run on all pushes and on all pull requests.
@@ -7,22 +7,34 @@ on:
     paths-ignore:
       - "**.md"
   pull_request:
+
   # Allow manually triggering the workflow.
   workflow_dispatch:
 
 jobs:
   checkcs:
-    name: "Basic CS and QA checks"
+    name: Lint checks for PHP ${{ matrix.php }}
     runs-on: ubuntu-latest
 
     env:
       XMLLINT_INDENT: "	"
 
+    strategy:
+      matrix:
+        php: ['7.1', '8.1']
+        experimental: [false]
+        include:
+          - php: '8.2'
+            experimental: true
+      fail-fast: false
+
+    continue-on-error: ${{ matrix.experimental }}
+
     steps:
-      - name: Setup PHP
+      - name: Setup PHP ${{ matrix.php }}
         uses: shivammathur/setup-php@v2
         with:
-          php-version: "7.4"
+          php-version: ${{ matrix.php }}
           coverage: none
           tools: cs2pr
 
@@ -37,34 +49,29 @@ jobs:
         uses: korelstar/xmllint-problem-matcher@v1
 
       - name: Checkout code
-        uses: actions/checkout@v2
-
-      # Validate the composer.json file.
-      # @link https://getcomposer.org/doc/03-cli.md#validate
-      - name: Validate Composer installation
-        run: composer validate --no-check-all
+        uses: actions/checkout@v3
 
       # Install dependencies and handle caching in one go.
-      # @link https://github.com/marketplace/actions/install-composer-dependencies
+      # @link https://github.com/marketplace/actions/install-php-dependencies-with-composer
       - name: Install Composer dependencies
-        uses: ramsey/composer-install@v1
+        if: ${{ matrix.php < 8.2 }}
+        uses: ramsey/composer-install@v2
+
+      - name: Install Composer dependencies for PHP >= 8.2
+        if: ${{ matrix.php >= 8.2 }}
+        uses: ramsey/composer-install@v2
+        with:
+          composer-options: --ignore-platform-reqs
 
       # 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
       - name: Lint phpunit.xml.dist
+        if: ${{ matrix.php >= 7.3 }}
         uses: ChristophWurst/xmllint-action@v1
         with:
           xml-file: ./phpunit.xml.dist
           xml-schema-file: ./vendor/phpunit/phpunit/phpunit.xsd
-
-      # Check the code-style consistency of the PHP files.
-#      - name: Check PHP code style
-#        continue-on-error: true
-#        run: vendor/bin/phpcs --report-full --report-checkstyle=./phpcs-report.xml
-
-#      - name: Show PHPCS results in PR
-#        run: cs2pr ./phpcs-report.xml

.github/workflows/deploy.yml

@@ -0,0 +1,29 @@
+name: Deploy to WordPress.org
+on:
+  release:
+    types: [released]
+jobs:
+  tag:
+    name: New tag
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Configure NPM cache
+        uses: c-hive/gha-npm-cache@v1
+
+      - name: Install Dependencies
+        run: npm install
+
+      - name: Populate Changelog
+        run: node .github/workflows/changelog.js
+        env:
+          TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: WordPress Plugin Deploy
+        uses: 10up/action-wordpress-plugin-deploy@stable
+        env:
+          SVN_PASSWORD: ${{ secrets.SVN_PASSWORD }}
+          SVN_USERNAME: ${{ secrets.SVN_USERNAME }}
+          SLUG: ad-code-manager

.github/workflows/integrations.yml

@@ -7,79 +7,77 @@ on:
     paths-ignore:
       - "**.md"
   pull_request:
+
   # Allow manually triggering the workflow.
   workflow_dispatch:
 
 jobs:
   test:
     name: WP ${{ matrix.wordpress }} on PHP ${{ matrix.php }}
-    # Ubuntu-20.x includes MySQL 8.0, which causes `caching_sha2_password` issues with PHP < 7.4
-    # https://www.php.net/manual/en/mysqli.requirements.php
-    # TODO: change to ubuntu-latest when we no longer support PHP < 7.4
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-20.04
 
     env:
       WP_VERSION: ${{ matrix.wordpress }}
 
     strategy:
+      # PHP 7.1 uses PHPUnit 7.5.20
+      # PHP 7.2 uses PHPUnit 8.5.21
+      # PHP 7.3 uses PHPUnit 9.5.10
+      # PHP 7.4 uses PHPUnit 9.5.10
+      # PHP 8.0 uses PHPUnit 9.5.10
+      # PHP 8.1 uses PHPUnit 9.5.10
+      # PHP 8.2 uses PHPUnit 9.5.10
+      # Key:
+      # - coverage: Whether to run the tests with code coverage.
+      # - experimental: Whether the build is "allowed to fail".
       matrix:
-        wordpress: ["5.5", "5.6", "5.7"]
-        php: ["5.6", "7.0", "7.1", "7.2", "7.3", "7.4"]
+        php: ['7.2', '7.3', '7.4', '8.0', '8.1']
+        wordpress: ['5.5', '5.6', '5.7', '5.8', '5.9']
+        experimental: [false]
+        coverage: [none]
         include:
-          - php: "8.0"
-            # Ignore platform requirements, so that PHPUnit 7.5 can be installed on PHP 8.0 (and above).
-            composer-options: "--ignore-platform-reqs"
-            extensions: pcov
-            ini-values: pcov.directory=., "pcov.exclude=\"~(vendor|tests)~\""
-            coverage: pcov
-        exclude:
-          - php: "8.0"
-            wordpress: "5.5"
+          - php: '7.1'
+            wordpress: '5.8.3'
+            experimental: false
+            coverage: none
       fail-fast: false
-
+    continue-on-error: ${{ matrix.experimental }}
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       - name: Setup PHP ${{ matrix.php }}
         uses: shivammathur/setup-php@v2
         with:
           php-version: ${{ matrix.php }}
           extensions: ${{ matrix.extensions }}
-          ini-values: ${{ matrix.ini-values }}
           coverage: ${{ matrix.coverage }}
 
       - name: Setup problem matchers for PHP
         run: echo "::add-matcher::${{ runner.tool_cache }}/php.json"
 
-      # Setup PCOV since we're using PHPUnit < 8 which has it integrated. Requires PHP 7.1.
-      # Ignore platform reqs to make it install on PHP 8.
-      # https://github.com/krakjoe/pcov-clobber
-      - name: Setup PCOV
-        if: ${{ matrix.php == 8.0 }}
-        run: |
-          composer require pcov/clobber --ignore-platform-reqs
-          vendor/bin/pcov clobber
-
       - name: Setup Problem Matchers for PHPUnit
         run: echo "::add-matcher::${{ runner.tool_cache }}/phpunit.json"
 
       - name: Install Composer dependencies
-        uses: ramsey/composer-install@v1
+        if: ${{ matrix.php < 8.2 }}
+        uses: ramsey/composer-install@v2
+
+      - name: Install Composer dependencies for PHP >= 8.2
+        if: ${{ matrix.php >= 8.2 }}
+        uses: ramsey/composer-install@v2
         with:
-          composer-options: "${{ matrix.composer-options }}"
+          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 test
-      - name: Run integration tests (single site with code coverage)
-        if: ${{ matrix.php == 8.0 }}
-        run: composer coverage-ci
-      - name: Run integration tests (multisite)
-        run: composer test-ms
+      - name: Run integration tests
+        run: composer test --no-interaction

.gitignore

@@ -1,2 +1,4 @@
-composer.lock
+/.phpunit.result.cache
+/composer.lock
+/package-lock.json
 /vendor

.phpcs.xml.dist

@@ -30,7 +30,7 @@
 	<rule ref="PHPCompatibilityWP"/>
 	<!-- For help in understanding this testVersion:
 		https://github.com/PHPCompatibility/PHPCompatibility#sniffing-your-code-for-compatibility-with-specific-php-versions -->
-	<config name="testVersion" value="5.6-"/>
+	<config name="testVersion" value="7.1-"/>
 
 	<!-- Rules: WordPress Coding Standards - see
 		https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards -->
@@ -49,6 +49,8 @@
 		<properties>
 			<property name="prefixes" type="array">
 				<element value="ad_code_manager"/>
+				<element value="acm"/>
+				<element value="Automattic\AdCodeManager"/>
 			</property>
 		</properties>
 	</rule>
@@ -67,4 +69,8 @@
 		</properties>
 	</rule>
 
+	<rule ref="WordPress.Files.FileName">
+		<exclude-pattern>tests/</exclude-pattern>
+	</rule>
+
 </ruleset>