Merge pull request #52 from 10up/release/2.2.0

Release/2.2.0

.gitattributes

@@ -1,10 +1,21 @@
-/.wordpress-org export-ignore
+# Directories
+/.git export-ignore
 /.github export-ignore
+/.wordpress-org export-ignore
+/tests export-ignore
 
+# Files
+/.DS_Store export-ignore
 /.gitattributes export-ignore
+/.gitignore export-ignore
 /CHANGELOG.md export-ignore
 /CODE_OF_CONDUCT.md export-ignore
 /composer.json export-ignore
+/composer.lock export-ignore
 /CONTRIBUTING.md export-ignore
+/CREDITS.md export-ignore
 /LICENSE.md export-ignore
-/README.md export-ignore
+/phpcs.xml export-ignore
+/phpunit.xml export-ignore
+/README.md export-ignore
+/wpacceptance.json export-ignore

.github/workflows/push-asset-readme-update.yml

@@ -2,15 +2,15 @@ name: Plugin asset/readme update
 on:
   push:
     branches:
-    - master
+    - trunk
 jobs:
-  master:
-    name: Push to master
+  trunk:
+    name: Push to trunk
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@master
     - name: WordPress.org plugin asset/readme update
-      uses: 10up/action-wordpress-plugin-asset-update@master
+      uses: 10up/action-wordpress-plugin-asset-update@stable
       env:
         SVN_PASSWORD: ${{ secrets.SVN_PASSWORD }}
         SVN_USERNAME: ${{ secrets.SVN_USERNAME }}

.github/workflows/push-deploy.yml

@@ -10,7 +10,7 @@ jobs:
     steps:
     - uses: actions/checkout@master
     - name: WordPress Plugin Deploy
-      uses: 10up/action-wordpress-plugin-deploy@master
+      uses: 10up/action-wordpress-plugin-deploy@stable
       env:
         SVN_PASSWORD: ${{ secrets.SVN_PASSWORD }}
         SVN_USERNAME: ${{ secrets.SVN_USERNAME }}

CHANGELOG.md

@@ -2,44 +2,74 @@
 
 All notable changes to this project will be documented in this file, per [the Keep a Changelog standard](http://keepachangelog.com/).
 
+## [Unreleased] - TBD
+
+## [2.2.0] - TBD
+### Added
+- `$args` parameter to `get_simple_local_avatar` function (props [@dinhtungdu](https://github.com/dinhtungdu), [@heyjones](https://github.com/heyjones), [@dkotter](https://github.com/dkotter), [@sumnercreations](https://github.com/sumnercreations), [@dshanske](https://github.com/dshanske) via [#40](https://github.com/10up/simple-local-avatars/pull/40))
+- `Simple_Local_Avatars::get_avatar_data()`, `Simple_Local_Avatars::get_simple_local_avatar_url()`, and `Simple_Local_Avatars::get_default_avatar_url()`, methods (props [@dinhtungdu](https://github.com/dinhtungdu), [@heyjones](https://github.com/heyjones), [@dkotter](https://github.com/dkotter), [@sumnercreations](https://github.com/sumnercreations), [@dshanske](https://github.com/dshanske) via [#40](https://github.com/10up/simple-local-avatars/pull/40))
+- Ability to retrieve avatar with `WP_Post` object (props [@oscarssanchez](https://github.com/oscarssanchez), [@blobaugh](https://github.com/blobaugh) via [#47](https://github.com/10up/simple-local-avatars/pull/47))
+- Add class and ID to Avatar section on Profile Page to allow easier styling of the section (props [@dinhtungdu](https://github.com/dinhtungdu) via [#54](https://github.com/10up/simple-local-avatars/pull/54))
+- [WP Acceptance](https://github.com/10up/wpacceptance/) test coverage (props [@dinhtungdu](https://github.com/dinhtungdu) via [#53](https://github.com/10up/simple-local-avatars/pull/53))
+
+### Changed
+- Switched to `pre_get_avatar_data` filter (props [@dinhtungdu](https://github.com/dinhtungdu), [@heyjones](https://github.com/heyjones), [@dkotter](https://github.com/dkotter), [@sumnercreations](https://github.com/sumnercreations), [@dshanske](https://github.com/dshanske) via [#40](https://github.com/10up/simple-local-avatars/pull/40))
+- `assign_new_user_avatar` function made public (props [@tripflex](https://github.com/tripflex) via [#48](https://github.com/10up/simple-local-avatars/pull/48))
+- Split the main class into its own file, added unit tests, and set up testing GitHub action (props [@dinhtungdu](https://github.com/dinhtungdu), [@helen](https://github.com/helen), [@stevegrunwell](https://github.com/stevegrunwell) via [#59](https://github.com/10up/simple-local-avatars/pull/59))
+- New plugin banner and icon (props [@JackieKjome](https://github.com/JackieKjome) via [#52](https://github.com/10up/simple-local-avatars/pull/52))
+- Bump WordPress version "tested up to" 5.5 (props [@Waka867](https://github.com/Waka867), [@tmoorewp](https://github.com/tmoorewp), [@jeffpaul](https://github.com/jeffpaul), [@dinhtungdu](https://github.com/dinhtungdu) via [#36](https://github.com/10up/simple-local-avatars/pull/36), [#43](https://github.com/10up/simple-local-avatars/pull/43), [#52](https://github.com/10up/simple-local-avatars/pull/52))
+- GitHub Actions from HCL to YAML workflow syntax (props [@jeffpaul](https://github.com/jeffpaul) via [#37](https://github.com/10up/simple-local-avatars/pull/37))
+- Documentation updates (props [@jeffpaul](https://github.com/jeffpaul) via [#29](https://github.com/10up/simple-local-avatars/pull/29), [#30](https://github.com/10up/simple-local-avatars/pull/30), [#33](https://github.com/10up/simple-local-avatars/pull/33), [#45](https://github.com/10up/simple-local-avatars/pull/45), [#50](https://github.com/10up/simple-local-avatars/pull/50), [#52](https://github.com/10up/simple-local-avatars/pull/52))
+
+### Fixed
+- Initialize `Simple_Local_Avatars` on the `$simple_local_avatars` global, enabling bundling plugin with composer (props [@pdewouters](https://github.com/pdewouters), [@adamsilverstein](https://github.com/adamsilverstein) via [#34](https://github.com/10up/simple-local-avatars/pull/34))
+
+### Removed
+- `get_avatar` fuinction that overrides the core function (props [@dinhtungdu](https://github.com/dinhtungdu), [@heyjones](https://github.com/heyjones), [@dkotter](https://github.com/dkotter), [@sumnercreations](https://github.com/sumnercreations), [@dshanske](https://github.com/dshanske) via [#40](https://github.com/10up/simple-local-avatars/pull/40))
+
 ## [2.1.1] - 2019-05-07
-* Fixed: Do not delete avatars just because they don't exist on the local filesystem. This was occasionally dumping avatars when WordPress uploads were stored elsewhere, e.g. a cloud service.
+### Fixed
+- Do not delete avatars just because they don't exist on the local filesystem. This was occasionally dumping avatars when WordPress uploads were stored elsewhere, e.g. a cloud service.
 
 ## [2.1] - 2018-10-24
 ### Added
-* All avatar uploads now go into the media library. Don't worry - users without the ability to upload files cannot otherwise see the contents of your media library. This allows local avatars to respect other functionality your site may have around uploaded images, such as external hosting.
-* REST API support for getting and updating.
-* Use .org language packs rather than bundling translations.
+- All avatar uploads now go into the media library. Don't worry - users without the ability to upload files cannot otherwise see the contents of your media library. This allows local avatars to respect other functionality your site may have around uploaded images, such as external hosting.
+- REST API support for getting and updating.
+- Use .org language packs rather than bundling translations.
+
 ### Fixed
-* Avoid an `ArgumentCountError`.
-* A couple of internationalization issues.
+- Avoid an `ArgumentCountError`.
+- A couple of internationalization issues.
 
 ## [2.0] - 2013-06-02
 ### Added
-* Choose or upload an avatar from the media library (for users with appropriate capabilities)!
-* Local avatars are rated for appropriateness, just like Gravatar
-* A new setting under Discussion enables administrators to turn off Gravatar (only use local avatars)
-* Delete the local avatar with a single button click (like everywhere else in WordPress)
-* Uploaded avatar file names are appended with the timestamp, addressing browser image caching issues
-* New developer filter for preventing automatic rescaling: simple_local_avatars_dynamic_resize
-* New developer filter for limiting upload size: simple_local_avatars_upload_limit
-* Upgraded functions deprecated since WordPress 3.5
-* Hungarian translation added (needs further updating again with new version)
+- Choose or upload an avatar from the media library (for users with appropriate capabilities)!
+- Local avatars are rated for appropriateness, just like Gravatar
+- A new setting under Discussion enables administrators to turn off Gravatar (only use local avatars)
+- Delete the local avatar with a single button click (like everywhere else in WordPress)
+- Uploaded avatar file names are appended with the timestamp, addressing browser image caching issues
+- New developer filter for preventing automatic rescaling: simple_local_avatars_dynamic_resize
+- New developer filter for limiting upload size: simple_local_avatars_upload_limit
+- Upgraded functions deprecated since WordPress 3.5
+- Hungarian translation added (needs further updating again with new version)
+
 ### Fixed
-* Fixed translations not working on front end (although translations are now a bit out of date...)
-* Assorted refactoring / improvements under the hood
+- Fixed translations not working on front end (although translations are now a bit out of date...)
+- Assorted refactoring / improvements under the hood
 
 ## [1.3.1] - 2011-12-29
 ### Added
-* Brazilian Portuguese and Belarusian translations
+- Brazilian Portuguese and Belarusian translations
+
 ### Fixed
-* Bug fixes (most notably correct naming of image files based on user display name)
-* Optimization for WordPress 3.2 / 3.3 (substitutes deprecated function)
+- Bug fixes (most notably correct naming of image files based on user display name)
+- Optimization for WordPress 3.2 / 3.3 (substitutes deprecated function)
 
 ## [1.3] - 2011-09-22
 ### Added
-- Avatar file name saved as "user-display-name_avatar" (or other image extension) 
+- Avatar file name saved as "user-display-name_avatar" (or other image extension)
 - Russian localization added
+
 ### Fixed
 - Assorted minor code optimizations
 
@@ -58,17 +88,19 @@ All notable changes to this project will be documented in this file, per [the Ke
 ## [1.2.1] - 2011-01-26
 ### Added
 - French localization
+
 ### Fixed
 - Simplify uninstall code
 
 ## [1.2] - 2011-01-26
-### Fixed
-- Fix path issues on some IIS servers (resulting in missing avatar images)
-- Fix rare uninstall issues related to deleted avatars
 ### Added
 - Spanish localization
 - Other minor under the hood optimizations
 
+### Fixed
+- Fix path issues on some IIS servers (resulting in missing avatar images)
+- Fix rare uninstall issues related to deleted avatars
+
 ## [1.1.3] - 2011-01-20
 ### Fixed
 - Properly deletes old avatars upon changing avatar
@@ -90,7 +122,8 @@ All notable changes to this project will be documented in this file, per [the Ke
 ## [1.0] - 2011-01-18
 - Initial release
 
-[Unreleased]: https://github.com/10up/simple-local-avatars/compare/master...develop
+[Unreleased]: https://github.com/10up/simple-local-avatars/compare/trunk...develop
+[2.2.0]: https://github.com/10up/simple-local-avatars/compare/2.1.1...2.2.0
 [2.1.1]: https://github.com/10up/simple-local-avatars/compare/2.1...2.1.1
 [2.1]: https://github.com/10up/simple-local-avatars/compare/2.0...2.1
 [2.0]: https://github.com/10up/simple-local-avatars/compare/1.3.1...2.0

CONTRIBUTING.md

@@ -24,15 +24,21 @@ For more on how 10up writes and manages code, check out our [10up Engineering Be
 
 ## Workflow
 
-The `develop` branch is the development branch which means it contains the next version to be released. `stable` contains the current latest release and `master` contains the corresponding stable development version. Always work on the `develop` branch and open up PRs against `develop`.
+The `develop` branch is the development branch which means it contains the next version to be released. `stable` contains the current latest release and `trunk` contains the corresponding stable development version. Always work on the `develop` branch and open up PRs against `develop`.
 
 ## Release instructions
 
-1. Version bump: Bump the version number in `simple-local-avatars.php`.
-2. Changelog: Add/update the changelog in both `readme.txt` and `README.md`
-3. Readme updates: Make any other readme changes as necessary. `README.md` is geared toward GitHub and `readme.txt` contains WordPress.org-specific content. The two are slightly different.
-4. Merge: Make a non-fast-forward merge from `develop` to `master`.
-5. SVN update: Copy files over to the `trunk` folder of an SVN checkout of the plugin. If the plugin banner, icon, or screenshots have changed, copy those to the top-level `assets` folder. Commit those changes.
-6. SVN tag: Make a folder inside `tags` with the current version number, copy the contents of `trunk` into it, and commit with the message `Tagging X.Y.Z`. There is also an SVN command for tagging; however, note that it runs on the remote and requires care because the entire WordPress.org plugins repo is actually single SVN repo.
-7. Check WordPress.org: Ensure that the changes are live on https://wordpress.org/plugins/simple-local-avatars/. This may take a few minutes.
-8. Git tag: Tag the release in Git and push the tag to GitHub. It should now appear under [releases](https://github.com/10up/simple-local-avatars/releases) there as well.
+1. Branch: Starting from `develop`, cut a release branch named `release/X.Y.Z` for your changes.
+1. Version bump: Bump the version number in `simple-local-avatars.php` and `readme.txt` if it does not already reflect the version being released.
+1. Changelog: Add/update the changelog in both `CHANGELOG.md` and `readme.txt`.
+1. Props: update `CREDITS.md` with any new contributors, confirm maintainers are accurate.
+1. New files: Check to be sure any new files/paths that are unnecessary in the production version are included in `.gitattributes`.
+1. Readme updates: Make any other readme changes as necessary. `README.md` is geared toward GitHub and `readme.txt` contains WordPress.org-specific content. The two are slightly different.
+1. Merge: Make a non-fast-forward merge from your release branch to `develop` (or merge the pull request), then do the same for `develop` into `trunk` (`git checkout trunk && git merge --no-ff develop`). `trunk` contains the latest stable release.
+1. Test: Run through common tasks while on `trunk` to be sure it functions correctly.
+1. Push: Push your `trunk` branch to GitHub (e.g. `git push origin trunk`).
+1. Release: Create a [new release](https://github.com/10up/simple-local-avatars/releases/new), naming the tag and the release with the new version number, and targeting the `trunk` branch.  Paste the changelog from `CHANGELOG.md` into the body of the release and include a link to the [closed issues on the milestone](https://github.com/10up/simple-local-avatars/milestone/#?closed=1).
+1. SVN: Wait for the [GitHub Action](https://github.com/10up/simple-local-avatars/actions) 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/simple-local-avatars/. This may take a few minutes.
+1. Close the milestone: Edit the [milestone](https://github.com/10up/simple-local-avatars/milestone/#) with release date (in the `Due date (optional)` field) and link to GitHub release (in the `Description` field), then close the milestone.
+1. Punt incomplete items: If any open issues or PRs which were milestoned for `X.Y.Z` do not make it into the release, update their milestone to `X.Y.Z+1`, `X.Y+1.0`, `X+1.0.0` or `Future Release`.