refactor(repo): Phase 1 — relocate orphaned example and tool#1914
Open
SamErde wants to merge 3 commits into
Open
refactor(repo): Phase 1 — relocate orphaned example and tool#1914SamErde wants to merge 3 commits into
SamErde wants to merge 3 commits into
Conversation
Contributor
📝 WalkthroughWalkthroughThis PR adds ChangesRepo Restructure Proposal
Estimated code review effort: 1 (Trivial) | ~5 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Up to standards ✅🟢 Issues
|
Contributor
There was a problem hiding this comment.
Pull request overview
Phase 1 of the planned repo restructure: adds the restructure proposal as the plan-of-record and relocates two previously orphaned artifacts (an Azure DevOps pipeline example and an offline download helper script) without changing shipped module source/layout.
Changes:
- Added
docs/proposals/repo-restructure.mddocumenting the phased migration plan and path-consumer inventory. - Relocated the multi-tenant Azure DevOps pipeline example into
docs/examples/. - Relocated the offline downloader script into
powershell/tools/to group PowerShell deliverables.
Reviewed changes
Copilot reviewed 1 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| powershell/tools/Save-MaesterOffline.ps1 | Adds the offline module download helper script under powershell/tools/. |
| docs/proposals/repo-restructure.md | Adds a detailed restructure proposal and phased migration plan. |
| docs/examples/multi-tenant-pipeline.yml | Adds the Azure DevOps multi-tenant pipeline example under docs/examples/. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
🧹 Nitpick comments (1)
docs/proposals/repo-restructure.md (1)
284-295: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winAlign Phase 1 with the actual destination.
This section talks about
website/docsandwebsite/static, but the PR objective moves the sample todocs/examples/. Please make the proposal name the same landing zone you’re actually introducing, or the placement guidance will be misleading.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/proposals/repo-restructure.md` around lines 284 - 295, Update the proposal text so it refers to the actual destination being introduced, `docs/examples/`, instead of `website/docs` or `website/static`. Keep the guidance aligned with the real landing zone by revising the Phase 1 placement instructions in the restructure proposal to mention the `docs/examples/` sample location consistently.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In `@docs/proposals/repo-restructure.md`:
- Around line 284-295: Update the proposal text so it refers to the actual
destination being introduced, `docs/examples/`, instead of `website/docs` or
`website/static`. Keep the guidance aligned with the real landing zone by
revising the Phase 1 placement instructions in the restructure proposal to
mention the `docs/examples/` sample location consistently.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro Plus
Run ID: e4aa505f-7fe0-45f1-86ae-68401ea18421
📒 Files selected for processing (3)
docs/examples/multi-tenant-pipeline.ymldocs/proposals/repo-restructure.mdpowershell/tools/Save-MaesterOffline.ps1
SamErde
added a commit
to SamErde/maester
that referenced
this pull request
Jul 8, 2026
CodeRabbit nitpick: Phase 1 in the restructure proposal still described the original approach (git rm the example + fold its YAML into website/docs), which contradicted what the PR actually does — git mv the sample to docs/examples/. Rewrote Phase 1 item 1 to describe the docs/examples/ move (and the standalone-vs-website-copy drift that motivates keeping the file), and updated the move-by-move safety summary row to match. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Contributor
Author
|
Addressed the review feedback (commit 362ce1d).
|
Phase 1 of the repository restructure (docs/proposals/repo-restructure.md):
relocate two orphaned files that have no in-repo consumers. No source code
or shipped-module output changes.
- Move powershell/examples/multi-tenant-pipeline.yml -> docs/examples/
(keep the sample as tracked documentation rather than deleting it).
- Move tools/Save-MaesterOffline.ps1 -> powershell/tools/, grouping the
user-facing offline-installer script with the PowerShell deliverables and
anticipating the Phase 4 powershell/{module,unit-tests,tools} layout.
- Add the restructure proposal as the plan of record.
Both moves use git mv (100% rename, history preserved). The moves touch no
build input (public/, internal/, assets/, the format file, tests/), so the
shipped module is unchanged; ./build/Build-MaesterModule.ps1,
./build/Test-MaesterModuleOutput.ps1, and the PSScriptAnalyzer pass all
succeed.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
CodeRabbit nitpick: Phase 1 in the restructure proposal still described the original approach (git rm the example + fold its YAML into website/docs), which contradicted what the PR actually does — git mv the sample to docs/examples/. Rewrote Phase 1 item 1 to describe the docs/examples/ move (and the standalone-vs-website-copy drift that motivates keeping the file), and updated the move-by-move safety summary row to match. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
SamErde
force-pushed
the
restructure/phase-1-orphans
branch
from
362ce1d to
aefdad6
Compare
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/proposals/repo-restructure.md`:
- Around line 23-42: The current-tree inventory in the proposal is incomplete
because it omits the top-level docs/ directory even though this document lives
there and Phase 1 introduces docs/examples/. Update the “Current tree (verified
against the working tree)” section to add docs/ alongside the other top-level
entries, keeping the inventory consistent with the actual repository layout.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro Plus
Run ID: 90bc977b-713a-4386-8b50-29a812568a29
📒 Files selected for processing (3)
docs/examples/multi-tenant-pipeline.ymldocs/proposals/repo-restructure.mdpowershell/tools/Save-MaesterOffline.ps1
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
📑 Description
Phase 1 of the repository restructure described in
docs/proposals/repo-restructure.md.This phase only relocates two orphaned files that have no in-repo consumers — there are
no source-code or shipped-module changes.
powershell/examples/multi-tenant-pipeline.yml→docs/examples/. The sample iskept as tracked documentation rather than deleted.
tools/Save-MaesterOffline.ps1→powershell/tools/. This groups the user-facingoffline-installer script with the rest of the PowerShell deliverables and anticipates the
Phase 4
powershell/{module, unit-tests, tools}layout. It is not a build script, sobuild/was the wrong home.docs/proposals/repo-restructure.md) as the plan ofrecord for the phased migration.
Both moves use
git mv(100% rename — history preserved).Closes #
✅ Checks
/powershell/tests/pester.ps1locally.ℹ️ Additional Information
Why this is safe. The relocations touch none of the build inputs (
powershell/public/,powershell/internal/,powershell/assets/,Maester.Format.ps1xml,tests/), so theshipped module is unchanged. A grep confirmed the two moved paths have no functional
consumers anywhere in the repo, workflows, or website.
Verification run locally on this branch:
./build/Build-MaesterModule.ps1— ✅ build complete (408 public functions, 67 ORCAclasses).
./build/Test-MaesterModuleOutput.ps1— ✅ built-module output validation passed../powershell/tests/pester.ps1— general tests incl. PSScriptAnalyzer ✅; theper-function suite was still running at submission time. Since the change is entirely
outside the test input scope, CI will confirm the full run here.
This is the first of a four-phase, independently-shippable migration; each subsequent phase
will be its own PR. See the proposal for the full plan and per-move safety ratings.
Summary by CodeRabbit
tests/naming) with a phasedgit mvmigration plan, dev-time shim, and required ignore/workflow/docs updates.