Updates to CONTRIBUTING.md (#406)

John Spellman · web-flow · commit 943490ca3f93 · 2023-05-02T11:58:49.000-06:00
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -96,6 +96,7 @@ jobs:
       - restore_cache:
           keys:
             - test-phpunit-74-dependencies-{{ checksum "composer.json" }}
+      - run: composer update
       - run: composer install -n --prefer-dist
       - save_cache:
           key: test-phpunit-74-dependencies-{{ checksum "composer.json" }}
@@ -136,6 +137,7 @@ jobs:
       - restore_cache:
           keys:
             - test-phpunit-74-dependencies-{{ checksum "composer.json" }}
+      - run: composer update
       - run: composer install -n --prefer-dist
       - save_cache:
           key: test-phpunit-74-dependencies-{{ checksum "composer.json" }}
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -8,7 +8,13 @@ Pull requests and issues are welcome!
 
 ## Workflow
 
-The `develop` branch is the development branch which means it contains the next version to be released. `master` contains the corresponding stable development version. Always work on the `develop` branch and open up PRs against `develop`.
+Development and releases are structured around two branches, `develop` and `master`. The `develop` branch is the default branch for the repository, and is the source and destination for feature branches.
+
+We prefer to squash commits (i.e. avoid merge PRs) from a feature branch into `develop` when merging, and to include the PR # in the commit message. PRs to `develop` should also include any relevent updates to the changelog in readme.txt. For example, if a feature constitutes a minor or major version bump, that version update should be discussed and made as part of approving and merging the feature into `develop`.
+
+`develop` should be stable and usable, though possibly a few commits ahead of the public release on wp.org.
+
+The `master` branch matches the latest stable release deployed to [wp.org](wp.org).
 
 ## Testing
 
@@ -25,13 +31,24 @@ Behat requires a Pantheon site with Redis enabled. Once you've created the site,
 
 ## Release Process
 
-1. Starting from `develop`, cut a release branch named `release_X.Y.Z` containing your changes.
-1. Update plugin version in `README.md`, `readme.txt`, and `wp-redis.php`.
-1. Update the Changelog with the latest changes.
-1. Create a PR against the `master` branch.
-1. After all tests pass and you have received approval from a CODEOWNER (including resolving any merge conflicts), merge the PR into `master`.
-1. Pull `master` locally, create a new tag, and push up.
+1. From `develop`, checkout a new branch `release_X.Y.Z`.
+1. Make a release commit:
+    * Drop the `-dev` from the version number in `README.md`, `readme.txt`, and `wp-redis.php`.
+    * Update the "Latest" heading in the changelog to the new version number with the date
+    * Commit these changes with the message `Release X.Y.Z`
+    * Push the release branch up.
+1. Open a Pull Request to merge `release_X.Y.Z` into `master`. Your PR should consist of all commits to `develop` since the last release, and one commit to update the version number. The PR name should also be `Release X.Y.Z`.
+1. After all tests pass and you have received approval from a [CODEOWNER](./CODEOWNERS), merge the PR into `master`. "Rebase and merge" is preferred in this case. _Never_ squash to `master`.
+1. Pull `master` locally, create a new tag (based on version number from previous steps), and push up. The tag should _only_ be the version number. It _should not_ be prefixed  `v` (i.e. `X.Y.Z`, not `vX.Y.X`).
 1. Confirm that the necessary assets are present in the newly created tag, and test on a WP install if desired.
-1. Create a [new release](https://github.com/pantheon-systems/wp-redis/releases/new) using the tag created in the previous steps, naming the release with the new version number, and targeting the tag created in the previous step. Paste the release changelog from the `Changelog` section of the `README` into the body of the release and include a link to the closed issues if applicable.
-1. Wait for the [_Release wp-redis plugin to wp.org_ action](https://github.com/pantheon-systems/wp-redis/actions/workflows/wordpress-plugin-deploy.yml) to finish deploying to the WordPress.org repository. If all goes well, users with SVN commit access for that plugin will receive an emailed diff of changes.
-1. Check WordPress.org: Ensure that the changes are live on https://wordpress.org/plugins/wp-redis/. This may take a few minutes.
+1. Create a [new release](https://github.com/pantheon-systems/wp-redis/releases/new) using the tag created in the previous steps, naming the release with the new version number, and targeting the tag created in the previous step. Paste the release changelog from the `Changelog` section of [the readme](readme.txt) into the body of the release, including the links to the closed issues if applicable.
+1. Wait for the [_Release wp-redis plugin to wp.org_ action](https://github.com/pantheon-systems/wp-redis/actions/workflows/wordpress-plugin-deploy.yml) to finish deploying to the WordPress.org plugin repository. If all goes well, users with SVN commit access for that plugin will receive an emailed diff of changes.
+1. Check WordPress.org: Ensure that the changes are live on [the plugin repository](https://wordpress.org/plugins/wp-redis/). This may take a few minutes.
+1. Following the release, prepare the next dev version with the following steps:
+    * `git checkout develop`
+    * `git rebase master`
+    * Update the version number in all locations, incrementing the version by one patch version, and add the `-dev` flag (e.g. after releasing `1.2.3`, the new verison will be `1.2.4-dev`)
+    * Add a new `** Latest **` heading to the changelog
+    * `git add -A .`
+    * `git commit -m "Prepare X.Y.X-dev"`
+    * `git push origin develop`
diff --git a/README.md b/README.md
@@ -5,7 +5,7 @@
 **Tags:** cache, plugin, redis
 **Requires at least:** 3.0.1
 **Tested up to:** 6.2
-**Stable tag:** 1.3.5
+**Stable tag:** 1.3.6-dev
 **License:** GPLv2 or later
 **License URI:** http://www.gnu.org/licenses/gpl-2.0.html
 
@@ -103,6 +103,10 @@ This declaration means use of `wp_cache_set( 'foo', 'bar', 'bad-actor' );` and `
 There's a known issue with WordPress `alloptions` cache design. Specifically, a race condition between two requests can cause the object cache to have stale values. If you think you might be impacted by this, [review this GitHub issue](https://github.com/pantheon-systems/wp-redis/issues/221) for links to more context, including a workaround.
 
 ## Changelog ##
+
+### Latest ###
+* Update Composer dependencies [[#401](https://github.com/pantheon-systems/wp-redis/pull/394)]
+
 ### 1.3.5 (April 6, 2023) ###
 * Bump tested up to version to 6.2
 * Update Composer dependencies [[#394](https://github.com/pantheon-systems/wp-redis/pull/394)]
diff --git a/behat.yml b/behat.yml
@@ -7,15 +7,6 @@ default:
       contexts:
         - Behat\MinkExtension\Context\MinkContext
         - PantheonSystems\PantheonWordPressUpstreamTests\Behat\AdminLogIn
-    core:
-      filters:
-        tags: "~@upstreamonly"
-      paths:
-        - vendor/pantheon-systems/pantheon-wordpress-upstream-tests/features
-      contexts:
-        - Behat\MinkExtension\Context\MinkContext
-        - PantheonSystems\PantheonWordPressUpstreamTests\Behat\AdminLogIn
-        - PantheonSystems\PantheonWordPressUpstreamTests\Behat\ResponseHeader
   extensions:
     Behat\MinkExtension:
       # base_url set by ENV
diff --git a/bin/behat-prepare.sh b/bin/behat-prepare.sh
@@ -30,6 +30,9 @@ set -ex
 terminus env:create  $TERMINUS_SITE.dev $TERMINUS_ENV
 terminus env:wipe $SITE_ENV --yes
 
+# Enable Redis
+terminus redis:enable $TERMINUS_SITE
+
 ###
 # Get all necessary environment details.
 ###
@@ -87,7 +90,9 @@ terminus build:workflow:wait $TERMINUS_SITE.$TERMINUS_ENV
 {
   terminus wp $SITE_ENV -- core install --title=$TERMINUS_ENV-$TERMINUS_SITE --url=$PANTHEON_SITE_URL --admin_user=$WORDPRESS_ADMIN_USERNAME --admin_email=wp-redis@getpantheon.com --admin_password=$WORDPRESS_ADMIN_PASSWORD
 } &> /dev/null
-terminus wp $SITE_ENV -- cache flush
+
+echo "Flush cache and setup environment..."
 terminus wp $SITE_ENV -- plugin activate wp-redis classic-editor
+terminus wp $SITE_ENV -- cache flush
 terminus wp $SITE_ENV -- theme activate twentyseventeen
 terminus wp $SITE_ENV -- rewrite structure '/%year%/%monthnum%/%day%/%postname%/'
diff --git a/composer.json b/composer.json
@@ -12,7 +12,7 @@
     "behat/behat": "^3.1",
     "behat/mink-extension": "^2.2",
     "behat/mink-goutte-driver": "^1.2",
-    "pantheon-systems/pantheon-wordpress-upstream-tests": "dev-master",
+    "pantheon-systems/pantheon-wordpress-upstream-tests": "dev-fix-behat-upstream-tests",
     "wp-coding-standards/wpcs": "dev-develop as 2.3.1",
     "dealerdirect/phpcodesniffer-composer-installer": "^1.0.0",
     "phpunit/phpunit": "^9",
diff --git a/composer.lock b/composer.lock
diff --git a/readme.txt b/readme.txt
diff --git a/wp-redis.php b/wp-redis.php
