Skip to content

docs: clarify that gitignored files are excluded from inputs #31594

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 25, 2025

Conversation

FrozenPandaz
Copy link
Collaborator

Add callout box to the inputs documentation explaining that .gitignored files are automatically excluded from inputs and won't affect task hash computation.

Fixes #31574

Generated with Claude Code

@FrozenPandaz FrozenPandaz requested a review from a team as a code owner June 13, 2025 23:30
@FrozenPandaz FrozenPandaz requested a review from jaysoo June 13, 2025 23:30
Copy link

vercel bot commented Jun 13, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
nx-dev ✅ Ready (Inspect) Visit Preview Jun 17, 2025 6:06pm

Copy link

nx-cloud bot commented Jun 13, 2025

View your CI Pipeline Execution ↗ for commit 7a40035.

Command Status Duration Result
nx affected --targets=lint,test,build,e2e,e2e-c... ✅ Succeeded 4m 37s View ↗
nx run-many -t check-imports check-commit check... ✅ Succeeded 11s View ↗
nx-cloud record -- nx-cloud conformance:check ✅ Succeeded 2s View ↗
nx-cloud record -- nx format:check ✅ Succeeded 3s View ↗
nx-cloud record -- nx sync:check ✅ Succeeded 2s View ↗
nx documentation ✅ Succeeded 29s View ↗

☁️ Nx Cloud last updated this comment at 2025-06-17 18:04:31 UTC

@@ -54,6 +54,10 @@ Prefixing a source file input with `^` means this entry applies to the project d
By default, Nx will use all files in a project as well as all files in the project's dependencies when computing a hash for tasks belonging to the project.
This may cause Nx to rerun some tasks even when files irrelevant to the task have changed but it ensures that by default, Nx always re-runs the task when it should.

{% callout type="info" title="Gitignored Files Are Excluded" %}
Files that are listed in `.gitignore` are automatically excluded from inputs. Nx will not consider gitignored files when computing the hash for tasks, so changes to ignored files will not invalidate the cache.
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

@claude I think this makes more sense by line 51

Copy link
Contributor

@claude claude bot Jun 13, 2025

Choose a reason for hiding this comment

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

Claude finished @FrozenPandaz's task —— View job


Todo List

  • Read the current inputs.md file to understand content structure
  • Move the callout box from line 58 to line 51 as requested
  • Commit the change to the PR branch
  • Update comment with completion status

Summary

I've successfully moved the "Gitignored Files Are Excluded" callout box from its original position (lines 57-59) to a more logical location right after the "Token Behavior with Nested Projects" callout (now at lines 51-53). This placement makes more contextual sense as it appears earlier in the source files section where users are learning about file patterns and input behavior.

The change has been committed to the PR branch: f78c9c2

@FrozenPandaz
Copy link
Collaborator Author

@claude fix the commit messages to match the commit lint and force push. You can squash too

Copy link
Contributor

claude bot commented Jun 14, 2025

Claude finished @FrozenPandaz's task —— View job


Todo List

  • Check current commit messages to understand format issues
  • Review commit lint configuration to understand required format
  • Fix commit messages to follow conventional commit format (add required scopes)
  • Squash commits into a single clean commit
  • Force push to update the PR branch

Summary

Fixed the commit message format to pass commit lint validation:

Before:

  • docs: move gitignored files callout to better location ❌ (missing scope)
  • docs: clarify that gitignored files are excluded from inputs ❌ (missing scope)

After:

  • docs(core): clarify that gitignored files are excluded from inputs ✅ (proper format with scope)

Changes made:

  1. Combined both commits into a single squashed commit
  2. Added required scope (core) to follow the conventional commit format: type(scope): subject
  3. Force pushed to update the PR branch

The commit now follows the repository's commit lint rules and should pass CI validation.


Add callout box to the inputs documentation explaining that .gitignored files are automatically excluded from inputs and won't affect task hash computation, and move it to a better location in the documentation.

Co-authored-by: Jason Jean <FrozenPandaz@users.noreply.github.com>
@github-actions github-actions bot force-pushed the claude/issue-31574-20250613_141810 branch from f78c9c2 to 3dc85d3 Compare June 14, 2025 02:53
@FrozenPandaz FrozenPandaz enabled auto-merge (squash) June 17, 2025 17:49
Jason said i could
@FrozenPandaz FrozenPandaz added the priority: medium Medium Priority (not high, not low priority) label Jun 23, 2025
@FrozenPandaz FrozenPandaz merged commit b7e73fe into master Jun 25, 2025
8 checks passed
@FrozenPandaz FrozenPandaz deleted the claude/issue-31574-20250613_141810 branch June 25, 2025 16:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority: medium Medium Priority (not high, not low priority)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Need to clarify how gitignore would affect nx inputs
4 participants