ci(docs): build only docs; fix affected filtering in workflow

[kattsushi]

Summary:\n- Build only @effectify/docs by defining explicit build target without dependsOn\n- Update docs workflow to check affected projects and build docs only when affected\n\nFiles changed:\n- .github/workflows/docs.yml\n- apps/docs/project.json\n\nOutcome:\n- CI no longer builds prisma or app projects when docs change\n- Pages deploys only when docs are affected\n

Summary by CodeRabbit

• Chores
  • Optimized the documentation build pipeline to conditionally build only when documentation files are modified, reducing unnecessary build executions and improving overall CI/CD efficiency.
  • Enhanced project configuration with standardized build, development, and preview workflow targets for improved development processes.

[coderabbitai]

📝 Walkthrough

Walkthrough

The pull request modifies the docs build workflow to conditionally trigger based on whether the @effectify/docs package is affected between commits, and adds explicit Nx run-script targets to the docs project configuration for build, dev, and preview operations.

Changes

Cohort / File(s)	Summary
GitHub Actions Workflow .github/workflows/docs.yml	Replaced direct nx affected call with a conditional check using nx show projects --affected to determine if @effectify/docs is affected; docs build now skips if not affected. Updated messaging to reflect the new detection logic.
Docs Project Targets apps/docs/project.json	Added targets section with three nx run-script targets (build, dev, preview), each configured with executor, caching policy, dependencies, and corresponding script values.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

• ci(docs): docs workflow with Nx affected gating and iconized steps #28: Modifies the docs workflow's Nx affected gating logic for conditional @effectify/docs detection and building.
• docs: deployment verification change in docs content #29: Updates docs content to trigger the Nx-affected docs build, complementing this PR's workflow and target configurations.

Poem

🐰 A rabbit hops through docs so fine,
With targets clean and workflows aligned,
When docs are touched, the builds take flight,
Conditional logic—oh what a sight! ✨

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The PR title clearly and accurately summarizes the main changes: updating the CI workflow to build only docs and fixing the affected project filtering logic.
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.}

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch docs/ci-docs-only-build

---

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

[nx-cloud]

View your CI Pipeline Execution ↗ for commit f02bd13

Command	Status	Duration	Result
nx affected --target=test --base=87c40a1ce45893...	✅ Succeeded	10s	View ↗
nx affected --target=lint --base=origin/master ...	✅ Succeeded	<1s	View ↗
nx affected --target=build --base=87c40a1ce4589...	✅ Succeeded	1s	View ↗
nx affected --target=typecheck --base=origin/ma...	✅ Succeeded	<1s	View ↗

---

☁️ Nx Cloud last updated this comment at 2026-02-07 23:52:49 UTC

[coderabbitai]

Actionable comments posted: 1

Caution

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

⚠️ Outside diff range comments (1)

.github/workflows/docs.yml (1)

88-88: ⚠️ Potential issue | 🟡 Minor

Same backtick issue in skip message.

Same command substitution problem as line 56.

🔧 Proposed fix

-          echo "Skipping deploy - `@effectify/docs` is not affected in this push."
+          echo "Skipping deploy - '@effectify/docs' is not affected in this push."

🤖 Fix all issues with AI agents

In @.github/workflows/docs.yml:
- Line 56: The echo line currently uses backticks around `@effectify/docs` which
causes command substitution; change the string in the echo call (the line
containing "Checking if `@effectify/docs` is affected between ${BASE}..${HEAD}")
to use single quotes or escape the backticks so the literal `@effectify/docs` is
printed (e.g., replace backticks with '\'' or use double quotes without
backticks) and ensure the ${BASE} and ${HEAD} variables still expand as
intended.

[coderabbitai]

⚠️ Potential issue | 🟡 Minor

Backticks trigger command substitution in bash.

The backticks around @effectify/docs will be interpreted as command substitution, not literal text. This will cause bash to try executing @effectify/docs as a command, producing an error or unexpected output.

🔧 Proposed fix: escape the backticks or use single quotes

-            echo "Checking if `@effectify/docs` is affected between ${BASE}..${HEAD}"
+            echo "Checking if '@effectify/docs' is affected between ${BASE}..${HEAD}"

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

	echo "Checking if `@effectify/docs` is affected between ${BASE}..${HEAD}"
	echo "Checking if '@effectify/docs' is affected between ${BASE}..${HEAD}"

🤖 Prompt for AI Agents

In @.github/workflows/docs.yml at line 56, The echo line currently uses
backticks around `@effectify/docs` which causes command substitution; change the
string in the echo call (the line containing "Checking if `@effectify/docs` is
affected between ${BASE}..${HEAD}") to use single quotes or escape the backticks
so the literal `@effectify/docs` is printed (e.g., replace backticks with '\'' or
use double quotes without backticks) and ensure the ${BASE} and ${HEAD}
variables still expand as intended.