Update CONTRIBUTING.md (#585)

* update contributing.md

* clarify where the changelogs are

CHANGELOG.md

@@ -1,26 +1,32 @@
 ## Changelog ##
-## 2.4.4 (April 7, 2023) ##
+
+### Latest ###
+* Updates CONTRIBUTING.md [[#585](https://github.com/pantheon-systems/solr-power/pull/585)]
+* Fixes typo in var which caused undefined notice [[#582](https://github.com/pantheon-systems/solr-power/pull/582)]
+* Update Composer dependencies [[#576](https://github.com/pantheon-systems/solr-power/pull/576)] [[#574](https://github.com/pantheon-systems/solr-power/pull/583)] [[#573](https://github.com/pantheon-systems/solr-power/pull/584)]
+
+### 2.4.5 (April 9, 2023) ###
+* Fixes missing vendor/ directory in previous release [[#580](https://github.com/pantheon-systems/solr-power/pull/580)]
+
+### 2.4.4 (April 7, 2023) ###
 * Update Composer dependencies [[#576](https://github.com/pantheon-systems/solr-power/pull/576)] [[#574](https://github.com/pantheon-systems/solr-power/pull/574)] [[#573](https://github.com/pantheon-systems/solr-power/pull/573)]
 * Fix failing tests [[#577](https://github.com/pantheon-systems/solr-power/pull/577)]
 * Update tested up to version
 
-## 2.4.3 (January 19, 2022) ##
+### 2.4.3 (January 19, 2022) ###
 * Include schema.xml in release distribution [[#568](https://github.com/pantheon-systems/solr-power/pull/568)]
 
-## 2.4.2 (December 2, 2022) ##
-* Re-add changelog heading to readme.txt [[#564](https://github.com/pantheon-systems/solr-power/pull/564)]
-
-## 2.4.2 (December 2, 2022) ##
+### 2.4.2 (December 2, 2022) ###
 * Re-add changelog heading to readme.txt [[#564](https://github.com/pantheon-systems/solr-power/pull/564)]
 
-## 2.4.1 (December 1, 2022) ##
+### 2.4.1 (December 1, 2022) ###
 * Fixes the WordPress `readme.txt` [[#562](https://github.com/pantheon-systems/solr-power/pull/562/)]
 
-## 2.4.0 (November 30, 2022) ##
+### 2.4.0 (November 30, 2022) ###
 * Adds Github Actions for building tag and deploying to wp.org. Add CONTRIBUTING.md. [[#551](https://github.com/pantheon-systems/solr-power/issues/551)]
 * Added SOLRPOWER_DISABLE_AUTOCOMMIT to disable autocommitting of posts, moved CHANGELOG to it's own file, added `$post->score` value to parsed search results [[#559](https://github.com/pantheon-systems/solr-power/pull/559)]
 
-## 2.3.3 (September 28, 2022) ##
+### 2.3.3 (September 28, 2022) ###
 * Fixes issue where options could not be saved [[#541](https://github.com/pantheon-systems/solr-power/issues/541)]
 * Enforces network activation requirement for WordPress multisite [[#538](https://github.com/pantheon-systems/solr-power/issues/538)]
 

CONTRIBUTING.md

@@ -4,7 +4,13 @@ Since 2.3.3 the default branch is `main`. Please make sure you are working again
 
 ## Workflow
 
-The `develop` branch is the development branch which means it contains the next version to be released. `main` 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 `main`. 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 `main` branch matches the latest stable release deployed to [wp.org](wp.org).
 
 ## Testing
 
@@ -23,12 +29,24 @@ Note that dependencies are installed via Composer and the `vendor` directory is
 
 ## Release Process
 
-1. Starting from `develop`, cut a release branch named `release_X.Y.Z` containing your changes.
-1. Update plugin version in `package.json`, `README.md`, `readme.txt`, and `solr-power.php`.
-1. Update the Changelog with the latest changes.
-1. Create a PR against the `main` branch.
-1. After all tests pass and you have received approval from a CODEOWNER (including resolving any merge conflicts), merge the PR into `main`.
-1. [Check the _Build and Tag_ action](https://github.com/pantheon-systems/solr-power/actions/workflows/build-tag.yml): a new tag named with the version number should've been created. It should contain all the built assets.
-1. Create a [new release](https://github.com/pantheon-systems/solr-power/releases/new), naming the release with the new version number, and targeting the tag created in the previous step. Paste the release changelog from `CHANGELOG.md` into the body of the release and include a link to the closed issues if applicable.
-1. Wait for the [_Release solr-power plugin to wp.org_ action](https://github.com/pantheon-systems/solr-power/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/solr-power/. This may take a few minutes.
+1. From `develop`, checkout a new branch `release_X.Y.Z`.
+1. Make a release commit:
+    * Drop the `-dev` from the version number in `package.json`, `README.md`, `readme.txt`, and `solr-power.php`.
+    * Update the "Latest" heading in the changelog (both `CHANGELOG.md` and in `readme.txt`) 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 `main`. 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 `main`. "Rebase and merge" is preferred in this case. _Never_ squash to `main`.
+1. Pull `main` 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/solr-power/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 solr-power plugin to wp.org_ action](https://github.com/pantheon-systems/solr-power/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/solr-power/). This may take a few minutes.
+1. Following the release, prepare the next dev version with the following steps:
+    * `git checkout develop`
+    * `git rebase main`
+    * 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`

README.md

@@ -4,7 +4,7 @@
 **Requires at least:** 4.6  
 **Requires PHP:** 7.1  
 **Tested up to:** 6.2  
-**Stable tag:** 2.4.4  
+**Stable tag:** 2.4.6-dev  
 **License:** GPLv2 or later  
 **License URI:** http://www.gnu.org/licenses/gpl-2.0.html
 

readme.txt

@@ -4,7 +4,7 @@ Tags: search
 Requires at least: 4.6
 Requires PHP: 7.1
 Tested up to: 6.2
-Stable tag: 2.4.4
+Stable tag: 2.4.6-dev
 License: GPLv2 or later
 License URI: http://www.gnu.org/licenses/gpl-2.0.html
 
@@ -228,6 +228,14 @@ To force-commit data when this variable is defined outside of a normal cron run,
 
 == Changelog ==
 
+= Latest =
+* Updates CONTRIBUTING.md [[#585](https://github.com/pantheon-systems/solr-power/pull/585)]
+* Fixes typo in var which caused undefined notice [[#582](https://github.com/pantheon-systems/solr-power/pull/582)]
+* Update Composer dependencies [[#576](https://github.com/pantheon-systems/solr-power/pull/576)] [[#574](https://github.com/pantheon-systems/solr-power/pull/583)] [[#573](https://github.com/pantheon-systems/solr-power/pull/584)]
+
+= 2.4.5 (April 9, 2023) =
+* Fixes missing vendor/ directory in previous release [[#580](https://github.com/pantheon-systems/solr-power/pull/580)]
+
 = 2.4.4 (April 7, 2023) =
 * Update Composer dependencies [[#576](https://github.com/pantheon-systems/solr-power/pull/576)] [[#574](https://github.com/pantheon-systems/solr-power/pull/574)] [[#573](https://github.com/pantheon-systems/solr-power/pull/573)]
 * Fix failing tests [[#577](https://github.com/pantheon-systems/solr-power/pull/577)]

solr-power.php

@@ -2,15 +2,15 @@
 /**
  * Plugin Name: Solr Power
  * Description: Allows WordPress sites to index and search content with ApacheSolr.
- * Version: 2.4.4
+ * Version: 2.4.6-dev
  * Author: Pantheon
  * Author URI: http://pantheon.io
  * Text Domain: solr-for-wordpress-on-pantheon
  *
  * @package Solr_Power
  **/
 
-define( 'SOLR_POWER_VERSION', '2.4.4' );
+define( 'SOLR_POWER_VERSION', '2.4.6-dev' );
 
 /**
  * Copyright (c) 2011-2022 Pantheon, Matt Weber, Solr Power contributors