Skip to content

Conversation

@RobbieTheWagner
Copy link
Member

@RobbieTheWagner RobbieTheWagner commented Jan 14, 2026

Summary by CodeRabbit

  • Chores

    • Build now includes the project README in distributed output and uses a simplified output layout.
    • Build scripts updated; repo ignore pattern adjusted for dist directories.
  • Packaging

    • Package metadata updated to expose explicit module/types entry points and mark package as side-effect free.
  • Documentation

    • Removed the source README (documentation will be provided via the distributed README).

✏️ Tip: You can customize this high-level summary in your review settings.

@coderabbitai
Copy link

coderabbitai bot commented Jan 14, 2026

📝 Walkthrough

Walkthrough

Build and publish configuration adjusted: .gitignore broadened, root build_lib script now copies README into package dist, ng-packagr destination set to local dist, project package.json updated with publish entries, and the project README removed.

Changes

Cohort / File(s) Summary
Ignore Pattern
\.gitignore
Changed ignore from /dist to dist, affecting which dist directories are ignored.
Root build script
package.json
scripts.build_lib updated from ng build shepherd to ng build shepherd && cp README.md projects/shepherd/dist/. Removed npm_pack and package scripts.
ng-packagr output
projects/shepherd/ng-package.json
Changed dest from "../../dist/angular-shepherd" to "dist", localizing build output.
Package publish metadata
projects/shepherd/package.json
Removed publishConfig.directory; added files: ["dist"], module, types, exports mappings, and sideEffects: false; preserved publishConfig.registry.
Documentation
projects/shepherd/README.md
Deleted project README (all contents removed).

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

  • More release-plan fixes #2875 — Modifies CI/workflow steps that run npm run build_lib and adjusts publish-related scripts; touches the same build/publish pipeline.

Poem

🐰 I hopped into dist with a tiny strut,
README tucked close in my little rut,
Paths shortened, exports set neat and slim,
A package prepared on a moonlit whim,
Cheerful crumbs left for the next commit.

🚥 Pre-merge checks | ✅ 2 | ❌ 1
❌ Failed checks (1 inconclusive)
Check name Status Explanation Resolution
Title check ❓ Inconclusive The title 'More release-plan tweaks' is generic and vague, using the non-descriptive term 'tweaks' without clarifying the specific package configuration or publishing changes being made. Use a more specific title that describes the main changes, such as 'Update package publishing configuration and build output directory' or 'Refactor package.json exports and ng-packagr output path'.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.



📜 Recent review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 95f8ee7 and 2ce8955.

📒 Files selected for processing (1)
  • package.json
🚧 Files skipped from review as they are similar to previous changes (1)
  • package.json

✏️ Tip: You can disable this entire section by setting review_details to false in your review settings.


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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
package.json (1)

17-18: npm_pack script path is stale and will fail.

The npm_pack script still references dist/angular-shepherd, but the ng-packagr output now goes to projects/shepherd/dist/. The package script will fail.

🔧 Suggested fix
-    "npm_pack": "cd dist/angular-shepherd && npm pack",
+    "npm_pack": "cd projects/shepherd/dist && npm pack",
🤖 Fix all issues with AI agents
In `@projects/shepherd/ng-package.json`:
- Line 3: The npm_pack script in the root package.json references the old output
path "cd dist/angular-shepherd" which no longer matches the ng-package.json dest
set to "dist" (outputting to projects/shepherd/dist/); update the npm_pack
script to cd into the new compiled folder (adjust the path to
projects/shepherd/dist/angular-shepherd or if the package is now directly under
projects/shepherd/dist, change to cd projects/shepherd/dist) and ensure
subsequent tar or npm pack commands target that corrected directory so the
package script can find the build output.

In `@projects/shepherd/package.json`:
- Around line 29-34: The package will publish a top-level dist/ folder which
breaks imports; restore the previous publish behavior by either re-adding
publishConfig.directory with the exact value publishConfig.directory:
"../../dist/angular-shepherd" so the built package contents are published at the
package root (correct for ng-packagr), or change the build/publish workflow
invoked by release-plan publish to output build artifacts directly into dist/
(removing the nested angular-shepherd subdir) and keep files: ["dist"]; update
the package.json to use the chosen approach so consumers import from
angular-shepherd as before.
📜 Review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f022d99 and dc1ca9a.

📒 Files selected for processing (5)
  • .gitignore
  • package.json
  • projects/shepherd/README.md
  • projects/shepherd/ng-package.json
  • projects/shepherd/package.json
💤 Files with no reviewable changes (1)
  • projects/shepherd/README.md
🔇 Additional comments (2)
.gitignore (1)

4-4: LGTM!

The pattern change from /dist to dist correctly ignores dist directories at any level, which aligns with the new build output location at projects/shepherd/dist/.

package.json (1)

13-13: Build script correctly updated.

The build_lib script now copies README.md to the correct output location at projects/shepherd/dist/.

✏️ Tip: You can disable this entire section by setting review_details to false in your review settings.

{
"$schema": "../../node_modules/ng-packagr/ng-package.schema.json",
"dest": "../../dist/angular-shepherd",
"dest": "dist",
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟠 Major

🧩 Analysis chain

🏁 Script executed:

cat projects/shepherd/ng-package.json

Repository: shipshapecode/angular-shepherd

Length of output: 295


🏁 Script executed:

cat package.json | jq '.scripts.npm_pack' 2>/dev/null || cat package.json | grep -A 5 '"npm_pack"'

Repository: shipshapecode/angular-shepherd

Length of output: 112


Fix misaligned output path in npm_pack script.

The dest in projects/shepherd/ng-package.json is now "dist" (resolving to projects/shepherd/dist/), but the root package.json npm_pack script still references cd dist/angular-shepherd. This mismatch will break the package script when it tries to locate the compiled output.

Update the npm_pack script to use the correct path that aligns with the new destination.

🤖 Prompt for AI Agents
In `@projects/shepherd/ng-package.json` at line 3, The npm_pack script in the root
package.json references the old output path "cd dist/angular-shepherd" which no
longer matches the ng-package.json dest set to "dist" (outputting to
projects/shepherd/dist/); update the npm_pack script to cd into the new compiled
folder (adjust the path to projects/shepherd/dist/angular-shepherd or if the
package is now directly under projects/shepherd/dist, change to cd
projects/shepherd/dist) and ensure subsequent tar or npm pack commands target
that corrected directory so the package script can find the build output.

@RobbieTheWagner RobbieTheWagner merged commit 4ed3760 into main Jan 14, 2026
3 checks passed
@RobbieTheWagner RobbieTheWagner deleted the more-release-plan-2 branch January 14, 2026 17:11
@coderabbitai coderabbitai bot mentioned this pull request Jan 14, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants