Skip to content
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

docs(core): document projectsAffectedByDependencyUpdates #27134

Merged
merged 1 commit into from
Jul 25, 2024

Conversation

AgentEnder
Copy link
Member

Current Behavior

No docs for new config flag

Expected Behavior

Docs 🎉

Related Issue(s)

Fixes #22259

@AgentEnder AgentEnder requested a review from a team as a code owner July 25, 2024 21:09
@AgentEnder AgentEnder requested a review from jaysoo July 25, 2024 21:09
Copy link

vercel bot commented Jul 25, 2024

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

Name Status Preview Updated (UTC)
nx-dev ✅ Ready (Inspect) Visit Preview Jul 25, 2024 10:52pm

@@ -244,6 +244,22 @@ Nx provides two methods to exclude glob patterns (files and folders) from `affec
- Glob patterns defined in your `.gitignore` file are ignored.
- Glob patterns defined in an optional `.nxignore` file are ignored.

## Marking Projects Affected by Dependency Updates

By default Nx will mark all projects as affected whenever your package manager's lock file changes. This is meant to be a failsafe in case Nx misses a project that should be affected by a dependency update. If you'd like to opt in to a smarter behavior you can configure Nx to only mark projects as affected if they actually depend on the updated packages.
Copy link
Member

Choose a reason for hiding this comment

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

  • Missing comma after "default - By default, Nx...
  • I would be more precise on "this is" for documentation, and we can remove mean to be since it's superfluous -- This behavior is a failsafe in case Nx...

@AgentEnder AgentEnder force-pushed the docs/projects-affected-by-dependency-updates branch from 7c68f7f to bdaffae Compare July 25, 2024 22:45
@AgentEnder AgentEnder merged commit 8e596c3 into master Jul 25, 2024
6 checks passed
@AgentEnder AgentEnder deleted the docs/projects-affected-by-dependency-updates branch July 25, 2024 23:18
jaysoo pushed a commit that referenced this pull request Jul 26, 2024
<!-- Please make sure you have read the submission guidelines before
posting an PR -->
<!--
https://github.com/nrwl/nx/blob/master/CONTRIBUTING.md#-submitting-a-pr
-->

<!-- Please make sure that your commit message follows our format -->
<!-- Example: `fix(nx): must begin with lowercase` -->

<!-- If this is a particularly complex change or feature addition, you
can request a dedicated Nx release for this pull request branch. Mention
someone from the Nx team or the `@nrwl/nx-pipelines-reviewers` and they
will confirm if the PR warrants its own release for testing purposes,
and generate it for you if appropriate. -->

## Current Behavior
No docs for new config flag

## Expected Behavior
Docs 🎉 

## Related Issue(s)
<!-- Please link the issue being fixed so it gets closed when this is
merged. -->

Fixes #22259
FrozenPandaz pushed a commit that referenced this pull request Jul 30, 2024
<!-- Please make sure you have read the submission guidelines before
posting an PR -->
<!--
https://github.com/nrwl/nx/blob/master/CONTRIBUTING.md#-submitting-a-pr
-->

<!-- Please make sure that your commit message follows our format -->
<!-- Example: `fix(nx): must begin with lowercase` -->

<!-- If this is a particularly complex change or feature addition, you
can request a dedicated Nx release for this pull request branch. Mention
someone from the Nx team or the `@nrwl/nx-pipelines-reviewers` and they
will confirm if the PR warrants its own release for testing purposes,
and generate it for you if appropriate. -->

## Current Behavior
No docs for new config flag

## Expected Behavior
Docs 🎉

## Related Issue(s)
<!-- Please link the issue being fixed so it gets closed when this is
merged. -->

Fixes #22259

(cherry picked from commit 8e596c3)
Copy link

This pull request has already been merged/closed. If you experience issues related to these changes, please open a new issue referencing this pull request.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 31, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

In package-based monorepos Nx flags as affected all packages when updating only one package
2 participants