Merge branch 'develop' into trunk

10up · May 13, 2024 · 8862ab3 · 8862ab3
2 parents c70c19b + 16039b8
commit 8862ab3
Show file tree

Hide file tree

Showing 14 changed files with 5,180 additions and 3,638 deletions.
diff --git a/.github/workflows/no-response.yml → .github/workflows/close-stale-issues.yml b/.github/workflows/no-response.yml → .github/workflows/close-stale-issues.yml
@@ -1,30 +1,36 @@
-name: No Response
+name: 'Close stale issues'
 
 # **What it does**: Closes issues where the original author doesn't respond to a request for information.
 # **Why we have it**: To remove the need for maintainers to remember to check back on issues periodically to see if contributors have responded.
-# **Who does it impact**: Everyone that works on docs or docs-internal.
 
 on:
-  issue_comment:
-    types: [created]
   schedule:
-    # Schedule for five minutes after the hour, every hour
-    - cron: '5 * * * *'
+    # Schedule for every day at 1:30am UTC
+    - cron: '30 1 * * *'
+
+permissions:
+  issues: write
 
 jobs:
-  noResponse:
+  stale:
     runs-on: ubuntu-latest
     steps:
-      - uses: lee-dohm/[email protected]
+      - uses: actions/stale@v9
         with:
-          token: ${{ github.token }}
-          daysUntilClose: 14 # Number of days of inactivity before an Issue is closed for lack of response
-          responseRequiredLabel: "needs:feedback" # Label indicating that a response from the original author is required
-          closeComment: >
+          days-before-stale: 7
+          days-before-close: 7
+          stale-issue-message: >
+            It has been 7 days since more information was requested from you in this issue and we have not heard back. This issue is now marked as stale and will be closed in 7 days, but if you have more information to add then please comment and the issue will stay open.
+          close-issue-message: >
             This issue has been automatically closed because there has been no response
             to our request for more information. With only the
             information that is currently in the issue, we don't have enough information
             to take action. Please reach out if you have or find the answers we need so
             that we can investigate further. See [this blog post on bug reports and the
             importance of repro steps](https://www.lee-dohm.com/2015/01/04/writing-good-bug-reports/)
-            for more information about the kind of information that may be helpful.
+            for more information about the kind of information that may be helpful.
+          stale-issue-label: 'stale'
+          close-issue-reason: 'not_planned'
+          any-of-labels: 'needs:feedback'
+          remove-stale-when-updated: true
+
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,117 +4,109 @@ All notable changes to this project will be documented in this file, per [the Ke
 
 ## [Unreleased] - TBD
 
-## [1.5.4] - 2024-02-29
-
+## [1.6.0] - 2024-05-13
 ### Added
+- WP-CLI command, `export`, to generate a CSV of the block catalog (props [@dsawardekar](https://github.com/dsawardekar), [@psorensen](https://github.com/psorensen), [@Sidsector9](https://github.com/Sidsector9) via [#52](https://github.com/10up/block-catalog/pull/52)).
+- Classic Editor block detection (props [@dsawardekar](https://github.com/dsawardekar), [@Sidsector9](https://github.com/Sidsector9) via [#53](https://github.com/10up/block-catalog/pull/53)).
+
+### Changed
+- Bump WordPress "tested up to" version 6.5 (props [@sudip-md](https://github.com/sudip-md), [@jeffpaul](https://github.com/jeffpaul) via [#51](https://github.com/10up/block-catalog/pull/51)).
+- Bump WordPress minimum from 5.7 to 6.3 (props [@sudip-md](https://github.com/sudip-md), [@jeffpaul](https://github.com/jeffpaul) via [#51](https://github.com/10up/block-catalog/pull/51)).
+- Replaced [lee-dohm/no-response](https://github.com/lee-dohm/no-response) with [actions/stale](https://github.com/actions/stale) to help with closing no-response/stale issues (props [@jeffpaul](https://github.com/jeffpaul) via [#48](https://github.com/10up/block-catalog/pull/48)).
 
+### Security
+- Bump `express` from 4.18.2 to 4.19.2 (props [@dependabot](https://github.com/apps/dependabot), [@Sidsector9](https://github.com/Sidsector9) via [#50](https://github.com/10up/block-catalog/pull/50)).
+- Bump `follow-redirects` from 1.15.5 to 1.15.6 (props [@dependabot](https://github.com/apps/dependabot), [@Sidsector9](https://github.com/Sidsector9) via [#50](https://github.com/10up/block-catalog/pull/50)).
+- Bump `postcss` from 7.0.39 to 8.4.33 (props [@dependabot](https://github.com/apps/dependabot), [@Sidsector9](https://github.com/Sidsector9) via [#50](https://github.com/10up/block-catalog/pull/50)).
+- Bump `10up-toolkit` from 5.2.3 to 6.0.1 (props [@dependabot](https://github.com/apps/dependabot), [@Sidsector9](https://github.com/Sidsector9) via [#50](https://github.com/10up/block-catalog/pull/50)).
+- Bump `webpack-dev-middleware` from 5.3.3 to 5.3.4 (props [@dependabot](https://github.com/apps/dependabot), [@Sidsector9](https://github.com/Sidsector9) via [#50](https://github.com/10up/block-catalog/pull/50)).
+
+## [1.5.4] - 2024-02-29
+### Added
 - Support for the WordPress.org plugin preview (props [@dkotter](https://github.com/dkotter), [@jeffpaul](https://github.com/jeffpaul) via [#38](https://github.com/10up/block-catalog/pull/38)).
 
 ### Changed
-
 - Significantly improved performance of block catalog reset on larger WordPress installations (props [@dsawardekar](https://github.com/dsawardekar), [@Sidsector9](https://github.com/Sidsector9) via [#41](https://github.com/10up/block-catalog/pull/41)).
 - Clean up NPM dependencies and update the minimum node version to 20 (props [@Sidsector9](https://github.com/Sidsector9), [@dsawardekar](https://github.com/dsawardekar) via [#43](https://github.com/10up/block-catalog/pull/43)).
 
 ### Security
-
 - Bump `tj-actions/changed-files` from 39 to 41 (props [@dependabot](https://github.com/apps/dependabot), [@peterwilsoncc](https://github.com/peterwilsoncc) via [#39](https://github.com/10up/block-catalog/pull/39)).
 - Bump `follow-redirects` from 1.15.2 to 1.15.4 (props [@dependabot](https://github.com/apps/dependabot), [@Sidsector9](https://github.com/Sidsector9) via [#40](https://github.com/10up/block-catalog/pull/40)).
 
 ## [1.5.3] - 2023-11-23
-
 ### Fixed
-
 - PHP 8.2 deprecation warnings (props [@dsawardekar](https://github.com/dsawardekar), [@ravinderk](https://github.com/ravinderk) via [#34](https://github.com/10up/block-catalog/pull/34)).
 
 ### Added
-
 - PHPUnit 9.x support (props [@dsawardekar](https://github.com/dsawardekar), [@ravinderk](https://github.com/ravinderk) via [#34](https://github.com/10up/block-catalog/pull/34)).
 
 ### Security
-
 - Bump `sharp` from 0.32.3 to 0.32.6 (props [@dependabot](https://github.com/apps/dependabot), [@faisal-alvi](https://github.com/faisal-alvi) via [#32](https://github.com/10up/block-catalog/pull/32)).
 
 ## [1.5.2] - 2023-11-16
-
 ### Changed
-
 - Bump WordPress "tested up to" version to 6.4 (props [@qasumitbagthariya](https://github.com/qasumitbagthariya), [@jeffpaul](https://github.com/jeffpaul) via [#28](https://github.com/10up/block-catalog/pull/28), [#29](https://github.com/10up/block-catalog/pull/29)).
 
 ## [1.5.1] - 2023-10-24
-
 **Note that this release changes the name of the base plugin file. As such, you'll probably need to reactivate the plugin after updating.**
 
 ### Added
-
 - Add our standard GitHub Action automations (props [@jeffpaul](https://github.com/jeffpaul), [@dsawardekar](https://github.com/dsawardekar), [@dkotter](https://github.com/dkotter) via [#10](https://github.com/10up/block-catalog/pull/10), [#20](https://github.com/10up/block-catalog/pull/20), [#22](https://github.com/10up/block-catalog/pull/22), [#23](https://github.com/10up/block-catalog/pull/23), [#24](https://github.com/10up/block-catalog/pull/24), [#25](https://github.com/10up/block-catalog/pull/25)).
 
 ### Changed
-
 - Update our plugin image assets (props [Brooke Campbell](https://www.linkedin.com/in/brookecampbelldesign/), [@jeffpaul](https://github.com/jeffpaul), [@dsawardekar](https://github.com/dsawardekar), [@faisal-alvi](https://github.com/faisal-alvi) via [#11](https://github.com/10up/block-catalog/pull/11), [#17](https://github.com/10up/block-catalog/pull/17)).
 - Updated the main plugin file name (props [@dkotter](https://github.com/dkotter), [@peterwilsoncc](https://github.com/peterwilsoncc), [@dsawardekar](https://github.com/dsawardekar) via [#18](https://github.com/10up/block-catalog/pull/18)).
 
 ### Security
-
 - Bump `@babel/traverse` from 7.22.8 to 7.23.2 (props [@dependabot](https://github.com/apps/dependabot), [@dkotter](https://github.com/dkotter) via [#21](https://github.com/10up/block-catalog/pull/21)).
 
 ## [1.5.0] - 2023-08-11
-
 ### Added
-
 - `Beta` Support Level (props [@jeffpaul](https://github.com/jeffpaul), [@dsawardekar](https://github.com/dsawardekar) via [#3](https://github.com/10up/block-catalog/pull/3)).
 - Adds support for multisite via WP CLI (props [@dsawardekar](https://github.com/dsawardekar), [@Sidsector9](https://github.com/Sidsector9) via [#9](https://github.com/10up/block-catalog/pull/9)).
 
 ### Fixed
-
 - Missing name in the `block_catalog_taxonomy_options` hook (props [@dsawardekar](https://github.com/dsawardekar), [@fabiankaegy](https://github.com/fabiankaegy) via [#6](https://github.com/10up/block-catalog/pull/6)).
 
 ## [1.4.0] - 2022-12-03
-
 - Improves Core Block Display Titles logic
 - Fixes parent term for blocks registered without namespace
 - Improve Reusable Block detection
 - Add hooks to support nested variations
 - Adds unit tests
 
 ## [1.3.2] - 2022-11-25
-
 - Updates readme.txt
 
 ## [1.3.1] - 2022-11-25
-
 - Minor docs updates
 
 ## [1.3.0] - 2022-11-25
-
 - Adds support for hierarchical classification
 - Improves WP CLI find command
 - Adds inline filter hook documentation
 - Updates screenshots
 
 ## [1.2.2] - 2022-11-25
-
 - Updates Documentation
 
 ## [1.2.1] - 2022-11-25
-
 - Improves block title detection when default title is missing.
 - Initial svn release
 
 ## [1.2.0] - 2022-11-24
-
 - Improves filter output with wp_kses.
 
 ## [1.1.0] - 2022-11-23
-
 - Improves batch indexing for larger sites.
 - Refactor delete index to use batch mode.
 - Improves error handling during indexing & deleting via WP-Admin.
 
 ## [1.0.1] - 2022-11-21
-
 - Initial release
 
 [Unreleased]: https://github.com/10up/block-catalog/compare/trunk...develop
+[1.6.0]: https://github.com/10up/block-catalog/compare/1.5.4...1.6.0
 [1.5.4]: https://github.com/10up/block-catalog/compare/1.5.3...1.5.4
 [1.5.3]: https://github.com/10up/block-catalog/compare/1.5.2...1.5.3
 [1.5.2]: https://github.com/10up/block-catalog/compare/1.5.1...1.5.2

diff --git a/CREDITS.md b/CREDITS.md
@@ -10,7 +10,7 @@ The following individuals are responsible for curating the list of issues, respo
 
 Thank you to all the people who have already contributed to this repository via bug reports, code, design, ideas, project management, translation, testing, etc.
 
-[Darshan Sawardekar (@dsawardekar)](https://github.com/dsawardekar), [Taylor Lovett (@tlovett1)](https://github.com/tlovett1), [Darin Kotter (@dkotter)](https://github.com/dkotter), [Jeffrey Paul (@jeffpaul)](https://github.com/jeffpaul), [Brooke Campbell](https://www.linkedin.com/in/brookecampbelldesign/), [Faisal Alvi (@faisal-alvi)](https://github.com/faisal-alvi), [Peter Wilson (@peterwilsoncc)](https://github.com/peterwilsoncc), [Depandabot (@dependabot)](https://github.com/apps/dependabot), [Sumit Bagthariya (@qasumitbagthariya)](https://github.com/qasumitbagthariya), [Ravinder Kumar (@ravinderk)](https://github.com/ravinderk), [Siddharth Thevaril (@Sidsector9)](https://github.com/Sidsector9).
+[Darshan Sawardekar (@dsawardekar)](https://github.com/dsawardekar), [Taylor Lovett (@tlovett1)](https://github.com/tlovett1), [Darin Kotter (@dkotter)](https://github.com/dkotter), [Jeffrey Paul (@jeffpaul)](https://github.com/jeffpaul), [Brooke Campbell](https://www.linkedin.com/in/brookecampbelldesign/), [Faisal Alvi (@faisal-alvi)](https://github.com/faisal-alvi), [Peter Wilson (@peterwilsoncc)](https://github.com/peterwilsoncc), [Depandabot (@dependabot)](https://github.com/apps/dependabot), [Sumit Bagthariya (@qasumitbagthariya)](https://github.com/qasumitbagthariya), [Ravinder Kumar (@ravinderk)](https://github.com/ravinderk), [Siddharth Thevaril (@Sidsector9)](https://github.com/Sidsector9), [Peter Sorensen (@psorensen)](https://github.com/psorensen), [Sudip Dadhaniya (@sudip-md)](https://github.com/sudip-md).
 
 ## Libraries
 

diff --git a/README.md b/README.md
@@ -2,47 +2,32 @@
 
 > Easily keep track of which Gutenberg Blocks are used across your site.
 
-[![Support Level](https://img.shields.io/badge/support-beta-blueviolet.svg)](#support-level) ![WordPress tested up to version](https://img.shields.io/badge/WordPress-v6.1%20tested-success.svg) [![GPLv2 License](https://img.shields.io/github/license/10up/block-catalog.svg)](https://github.com/10up/block-catalog/blob/develop/LICENSE.md)
-
-## Table of Contents
-* [Features](#features)
-* [Requirements](#requirements)
-* [Installation](#installation)
-* [Getting Started](#getting-started)
-* [WP CLI Commands](#wp-cli-commands)
-* [FAQs](#frequently-asked-questions)
-* [Support](#support-level)
-* [Changelog](#changelog)
-* [Contributing](#contributing)
+[![Support Level](https://img.shields.io/badge/support-beta-blueviolet.svg)](#support-level) ![WordPress Plugin: Tested WP Version](https://img.shields.io/wordpress/plugin/tested/block-catalog?label=WordPress) ![WordPress Plugin Required PHP Version](https://img.shields.io/wordpress/plugin/required-php/block-catalog?label=Requires%20PHP) ![WordPress Plugin: Required WP Version](https://img.shields.io/wordpress/plugin/wp-version/block-catalog?label=Requires%20WordPress) https://img.shields.io/wordpress/plugin/tested/block-catalog?label=WordPress%20compatibility [![GPL-2.0-or-later License](https://img.shields.io/github/license/10up/block-catalog.svg)](https://github.com/10up/block-catalog/blob/develop/LICENSE.md)
 
 ## Features
 
-* Find which blocks are used across your site.
-* Fully Integrated with the WordPress Admin.
-* Use filters to see Posts that use a specific block.
-* Find Posts that use Reusable Blocks.
-* Use the WP CLI to quickly find blocks from the command line.
-* Use custom WordPress filters to extend the Block Catalog.
-* Find block usage on a Multisite network.
-
-## Requirements
-
-* PHP 7.4+
-* [WordPress](http://wordpress.org) 5.7+
+- Find which blocks are used across your site.
+- Fully Integrated with the WordPress Admin.
+- Use filters to see Posts that use a specific block.
+- Find Posts that use Reusable Blocks.
+- Use the WP CLI to quickly find blocks from the command line.
+- Use custom WordPress filters to extend the Block Catalog.
+- Find block usage on a Multisite network.
+- Export block catalog data to a CSV file via the WP CLI.
 
 ## Installation
 
-* Block Catalog can be installed like any other plugin from the [WordPress.org plugin directory](https://wordpress.org/plugins/block-catalog).
-* You can also install the plugin manually by [downloading a zip file](https://github.com/10up/block-catalog/releases/latest).
-* To install the plugin using [composer](https://getcomposer.org) and [wpackagist](https://wpackagist.org/), add the following to your composer.json.
+- Block Catalog can be installed like any other plugin from the [WordPress.org plugin directory](https://wordpress.org/plugins/block-catalog).
+- You can also install the plugin manually by [downloading a zip file](https://github.com/10up/block-catalog/releases/latest).
+- To install the plugin using [composer](https://getcomposer.org) and [wpackagist](https://wpackagist.org/), add the following to your composer.json.
 
 ```json
 "wpackagist-plugin/block-catalog":"~1.3.1"
 ```
 
 ## Getting Started
 
-On activation, the plugin will prompt you to index your content. You need to do this first before you will be able to see the various blocks used on your site. You can also go to *WP-Admin > Tools > Block Catalog* to do this yourself.
+On activation, the plugin will prompt you to index your content. You need to do this first before you will be able to see the various blocks used on your site. You can also go to _WP-Admin > Tools > Block Catalog_ to do this yourself.
 
 ![Screenshot of Block Catalog Tools](.wordpress-org/screenshot-1.png)
 
@@ -64,67 +49,81 @@ You can also filter the listing to only show Posts that have a specific block.
 
 The following WP CLI commands are supported by the Block Catalog plugin.
 
-* `wp block-catalog index [--only=<only>] [--dry-run]`
-	Iterates through all posts and catalogs them one at a time.
+- `wp block-catalog index [--only=<only>] [--dry-run]`
+  Iterates through all posts and catalogs them one at a time.
 
-  * [--reset]
+  - [--reset]
     Deletes the previous index before starting.
 
-  * [--only=\<only\>]
+  - [--only=\<only\>]
     Limits the command to the specified comma delimited post ids.
 
-  * [--network=\<network\>]
+  - [--network=\<network\>]
     Indexes the entire network. Accepts a comma delimited list of child site ids.
 
-  * [--dry-run]
+  - [--dry-run]
     Runs catalog without saving changes to the DB.
 
-* `wp block-catalog find <blocks>... [--index] [--fields] [--format] [--post_type] [--posts_per_page] [--post_status] [--count=<count>] [--operator=<operator>]`
-   Finds the list of posts having the specified block(s)
+- `wp block-catalog find <blocks>... [--index] [--fields] [--format] [--post_type] [--posts_per_page] [--post_status] [--count=<count>] [--operator=<operator>]`
+  Finds the list of posts having the specified block(s)
 
-  * \<blocks\>...
+  - \<blocks\>...
     The block names to search for, eg:- core/embed
 
-  * [--index]
+  - [--index]
     Whether to re-index before searching.
 
-  * [--fields=\<fields\>]
+  - [--fields=\<fields\>]
     List of post fields to display.
 
-  * [--format=\<format\>]
+  - [--format=\<format\>]
     Output format, default table.
 
-  * [--post_type=\<post_type\>]
+  - [--post_type=\<post_type\>]
     Limit search to specified post types.
 
-  * [--posts_per_page=\<posts_per_page\>]
+  - [--posts_per_page=\<posts_per_page\>]
     Number of posts to find per page, default 20
 
-  * [--post_status=\<post_status\>]
+  - [--post_status=\<post_status\>]
     Post status of posts to search, default 'publish'
 
-  * [--count=\<count\>]
+  - [--count=\<count\>]
     Prints total found posts, default true. When combined with `--network` prints an aggregate across the multisite.
 
-  * [--operator=\<operator\>]
+  - [--operator=\<operator\>]
     The query operator to be used in the search clause. Default IN.
 
-  * [--network=\<network\>]
+  - [--network=\<network\>]
     Searches across the entire network if on multisite. Accepts a comma delimited list of child site ids.
 
-* `wp block-catalog delete-index`
-   Resets the Block Catalog by removing all catalog terms.
+- `wp block-catalog delete-index`
+  Resets the Block Catalog by removing all catalog terms.
 
-  * [--network=\<network\>]
+  - [--network=\<network\>]
     Deletes the indexes across the entire network. Accepts a comma delimited list of child site ids.
 
+- `wp block-catalog post-blocks <post-id> [--index]`
+  Prints the list of blocks in the specified post.
 
-* `wp block-catalog post-blocks <post-id> [--index]`
-   Prints the list of blocks in the specified post.
-
-  * \<post-id\>
+  - \<post-id\>
     The post id to lookup blocks for.
 
+- `wp block-catalog export [--output=<output>] [--post_type=<types>] [--posts_per_block=<number>] [--ignore_parent=<ignore_parent>]`
+  Exports the posts associated with the 'block_catalog' taxonomy to a CSV file.
+
+  - `[--output=<output>]`
+    Path to the CSV file. Defaults to `/tmp/block-catalog.csv`.
+
+  - `[--post_type=<types>]`
+    Comma-delimited list of post types. Optional.
+
+  - `[--posts_per_block=<number>]`
+    Number of posts per block, default to -1 (all). Optional.
+
+  - `[--ignore_parent=<ignore_parent>]`
+    Ignore top level blocks. Optional. Default true.
+
 ## Frequently Asked Questions
 
 ### 1) Why does the Plugin require indexing?