Skip to content

doc(versions): version visibility docs and Unit/Feature test split#17

Merged
jfrosorio merged 5 commits into
mainfrom
doc-15-main
Jul 14, 2026
Merged

doc(versions): version visibility docs and Unit/Feature test split#17
jfrosorio merged 5 commits into
mainfrom
doc-15-main

Conversation

@jfrosorio

@jfrosorio jfrosorio commented Jul 14, 2026

Copy link
Copy Markdown
Contributor

Description

Version-visibility docs on the default branch, plus the Laravel-convention test layout:

Docs

  • README requirements table gains a Status column and links to the v2 / v1 maintenance branches (1.x row added)
  • UPGRADE.md gains the 1.x → 2.0 section, so the full upgrade path (1 → 2 → 3) is discoverable from main, and a 3.0 → 3.1 section documenting the default-on redaction
  • Timing/trait-guard notes in the 2.x → 3.0 section now correctly attribute those changes to 2.1
  • vendor:publish snippets use a quoted, single-backslash provider argument (portable across shells)

Tests

  • Tests split into tests/Unit and tests/Feature (Laravel convention) with separate PHPUnit testsuites; namespaces follow the directories
  • RedactorTest parent import aliased to PHPUnitTestCase for clarity

Fixes

This fixes #15 (main part; #16 covers the v1 branch — ideally merge that first, since merging this PR auto-closes the issue).

@jfrosorio jfrosorio self-assigned this Jul 14, 2026
@jfrosorio jfrosorio added the documentation Improvements or additions to documentation label Jul 14, 2026
@jfrosorio
jfrosorio requested a review from Copilot July 14, 2026 15:24

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Improves version visibility and upgrade documentation on the default branch by adding status/branch links in the README and expanding the upgrade guide to include the full 1→2→3 path, while also reorganizing the PHPUnit test suites/namespaces.

Changes:

  • Add a “Status” column and include a 1.x row in the README requirements table, linking to v1/v2 branches.
  • Extend UPGRADE.md with a 1.x → 2.0 section and update 2.x guidance; add a 3.0 → 3.1 note about default redaction behavior.
  • Split PHPUnit suites into Unit/Feature directories and update test namespaces; ignore PHPUnit result cache file.

Reviewed changes

Copilot reviewed 6 out of 7 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
UPGRADE.md Adds 1.x → 2.0 section, updates 2.x messaging, and adds 3.0 → 3.1 behavioral note.
README.md Adds a status column and v1/v2 links to the requirements table.
tests/Unit/RedactorTest.php Moves test into Tests\\Unit namespace and avoids base TestCase collision.
tests/Feature/LogApiRequestMiddlewareTest.php Moves test into Tests\\Feature namespace and imports package TestCase explicitly.
tests/Feature/HasApiLogsTest.php Moves test into Tests\\Feature namespace and imports package TestCase explicitly.
phpunit.xml Splits test suites into Unit and Feature directories.
.gitignore Adds PHPUnit result cache to ignored files.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread phpunit.xml
Comment thread UPGRADE.md Outdated
@jfrosorio jfrosorio changed the title doc(versions): add version status table and 1.x upgrade path doc(versions): version visibility docs and Unit/Feature test split Jul 14, 2026
@jfrosorio
jfrosorio merged commit 794917d into main Jul 14, 2026
8 checks passed
@jfrosorio
jfrosorio deleted the doc-15-main branch July 14, 2026 15:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Make version requirements and upgrade path visible on legacy branches

2 participants