Skip to content

Rewrite the changelog and readme.txt for the 1.0.0 release (#6) - #13

Merged
sean-e-dietrich merged 2 commits into
mainfrom
docs/6-first-release-changelog
Sep 28, 2026
Merged

sean-e-dietrich merged 2 commits into
mainfrom
docs/6-first-release-changelog

Conversation

@sean-e-dietrich

Copy link
Copy Markdown
Contributor

Fixes #6

Merge order: after #10, #11 and #12

The [1.0.0] entry describes the plugin as it will ship, and that includes what the three open PRs add:

If this merges first, main has a changelog describing features it doesn't have yet. A trial merge of #10, #11, #12 and this branch onto main has no conflicts. My README edits are two single lines, away from the hunks those PRs touch.

CHANGELOG.md

  • A single ## [1.0.0] entry covering what the plugin is at release: rule types, responses, evaluation paths, screens, storage and cache backends, logging, challenges, presets, incident tools, WP-CLI, Site Health, hooks, export/import, capabilities, uninstall, schema upgrades and the release zip. Built on kanopi/firewall ^2.33, bundling 2.33.0. The Security section from the old entry is kept and brought up to date.
  • An empty ## [Unreleased] above it. The Keep a Changelog intro is unchanged.
  • The Fixed entries are gone, because they fixed code that was never released. This also removes the repeated bullets Release pipeline: exercise the zip, check versions, publish on a tag (#7) #12 flagged at the end of the file. What a pre-release install still needs is in Upgrading from a pre-release build:
    • the automatic schema rewrites: private://, regex bodies, geo/ASN variable names, record_request
    • what is translated at compile time instead: the old operator names and the geo reader keys
    • two things to check by hand: the UA detection cache, and geo/ASN readers
    • refreshing the mu-plugin loader
    • the uninstall ownership marker

Counts checked against the code:

Claim Source Count
Rule types src/RuleType/Registry.php 10
Admin screens src/Admin/Admin.php 15: 14 in the menu, plus the rule editor
WP-CLI subcommands src/Cli/Commands.php 15
Site Health tests Site_Health::test_map() 17

None of #10–#12 changes these counts.

Release date

There is no date yet. The heading is plain ## [1.0.0], which both of #12's scripts accept. They strip an optional trailing - YYYY-MM-DD. Add the date when tagging (## [1.0.0] - YYYY-MM-DD), as the issue's last task says. Neither script needed changing.

readme.txt

  • = 1.0.0 = summary in place of = Unreleased =, and the stale one-line = 1.0.0 = is gone.
  • Tested up to: 7.1, up from 6.9. CI's integration-wplatest-php8.3 job installs WordPress 7.1.2 and passes (CircleCI job 120, on Release pipeline: exercise the zip, check versions, publish on a tag (#7) #12). The local DDEV site runs 6.9.7, and the nightly jobs run trunk. 7.1 is the newest major.minor the suite has actually passed on.
  • Requires at least: 6.4 and Requires PHP: 8.1 match the plugin header, composer.json and the CI floor job. Stable tag: 1.0.0 matches the header and BASIC_FIREWALL_VERSION.
  • Corrected "database storage cannot be used on the wp-config.php path". Since Early-path storage, referenced lists, and the first green CI run #1 it works when the snippet sits below the DB_ constants, as the README already says.
  • Installation now points to GitHub Releases, says Firewall → Status (the menu label, not "Dashboard"), and gives the vcs Composer route, since the package is not on Packagist.

README.md

Verification

Fold [Unreleased] into a single [1.0.0] entry describing the plugin as it
ships, including what #10, #11 and #12 add. Drop Fixed entries for code that
never reached a release; keep what a pre-release install needs to know in an
'Upgrading from a pre-release build' subsection. Leave an empty [Unreleased].

readme.txt: a 1.0.0 changelog summary, Tested up to 7.1 (CI's WP latest job
runs 7.1.2), GitHub Releases and vcs Composer install, Firewall -> Status,
and correct the claim that database storage cannot work on the early path.

README.md: the snippet is printed on the Status screen, not a Dashboard.
@sean-e-dietrich
sean-e-dietrich merged commit 41e5e63 into main Sep 28, 2026
12 checks passed
@sean-e-dietrich
sean-e-dietrich deleted the docs/6-first-release-changelog branch September 28, 2026 17:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Rewrite the changelog and readme.txt for a first release

1 participant