Skip to content

Commit

Permalink
Add top-level comment explaining the script
Browse files Browse the repository at this point in the history
  • Loading branch information
mcsf committed Jun 10, 2023
1 parent c896c86 commit c7a4ebb
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions bin/list-experimental-api-matches.sh
Original file line number Diff line number Diff line change
@@ -1,5 +1,15 @@
#!/bin/sh

# Generate a Markdown-formatted list of experimental APIs found across our
# packages and lib, providing GitHub search links for each match.
#
# Experimental APIs must be regularly audited, particularly in the context of
# major WordPress releases. This script allows release leads to generate a list
# to share in release issues.
#
# @see example audit issue for WordPress 6.2:
# https://github.com/WordPress/gutenberg/issues/47196

# Exit if any command fails.
set -e

Expand Down

0 comments on commit c7a4ebb

Please sign in to comment.