Exclude Apps in affected scripts by tags from nx.json #1621

mehrad-rafigh · 2019-07-24T17:39:30Z

Currently the only way to exclude apps and libs from being processed by the affected scripts, is by their names.
It would be useful, if we could exclude apps and libs in the affected scripts by their tags which can be defined in nx.json

For example having the following nx.json

....
    "booking": {
      "tags": ["booking"]
    },
    "error-page": {
      "tags": ["error-page"]
    },
    "my-nanosite": {
      "tags": ["my-nanosite", "nanosites"]
    },
    "my-other-nanosite": {
      "tags": ["my-other-nanosite", "nanosites"]
    },
...

and running npm run affected:apps -- --base=origin/develop --exclude="tags:nanosites" or something similar :) only apps should printed out, which are affected by changes and do not have the nanosites tag.
It should also be possible to pass a list of tags to be excluded.
This would save us a lot of headaches, because we have more than 50 nanosites and adding them by name in the exclude part is tedious and error prone.

I know the nx.json is used for linting, but could that purpose be extended?

The text was updated successfully, but these errors were encountered:

wesleygrimes · 2019-07-26T14:45:19Z

Hi @mehrad-rafigh, I am working on a new feature to have the ability to ignore glob patterns from the affected commands using either a .nxignore file or nx.json -> ignore property. Would this meet your needs?

PR #1585

mehrad-rafigh · 2019-07-27T07:35:11Z

Hi @wesleygrimes, I looked over your pull request. It doesn't add the feature I am looking for.
I want to be able to exclude entire apps by their tag names from affected:apps,test,lint and the such for example.

mehrad-rafigh · 2019-07-27T10:59:45Z

#1274 somehow relates to my feature request

alfaproject · 2019-07-27T11:31:36Z

Yeah I was going to say this is a duplicate d:

alfaproject · 2019-07-28T21:17:43Z

I'm currently applying this patch using patch-package to achieve what I need in my project:

diff --git a/node_modules/@nrwl/workspace/src/command-line/affected.js b/node_modules/@nrwl/workspace/src/command-line/affected.js
index ac6c7d7..87927e6 100644
--- a/node_modules/@nrwl/workspace/src/command-line/affected.js
+++ b/node_modules/@nrwl/workspace/src/command-line/affected.js
@@ -117,8 +117,8 @@ function affected(parsedArgs) {
 exports.affected = affected;
 function getProjects(target, parsedArgs, workspaceResults, all) {
     var projects = all
-        ? shared_1.getAllProjectsWithTarget(target)
-        : shared_1.getAffectedProjectsWithTarget(target)(shared_1.parseFiles(parsedArgs).files);
+        ? shared_1.getAllProjectsWithTarget(target, parsedArgs.tags)
+        : shared_1.getAffectedProjectsWithTarget(target, parsedArgs.tags)(shared_1.parseFiles(parsedArgs).files);
     return projects
         .filter(function (project) { return !parsedArgs.exclude.includes(project); })
         .filter(function (project) { return !parsedArgs.onlyFailed || !workspaceResults.getResult(project); });
@@ -277,6 +277,7 @@ var dummyOptions = {
     head: 'head',
     exclude: ['exclude'],
     files: [''],
+    tags: [],
     verbose: false
 };
 var nxSpecificFlags = Object.keys(dummyOptions);
diff --git a/node_modules/@nrwl/workspace/src/command-line/nx-commands.js b/node_modules/@nrwl/workspace/src/command-line/nx-commands.js
index 200d5c9..ebfa4c0 100644
--- a/node_modules/@nrwl/workspace/src/command-line/nx-commands.js
+++ b/node_modules/@nrwl/workspace/src/command-line/nx-commands.js
@@ -134,6 +134,12 @@ function withAffectedOptions(yargs) {
         type: 'array',
         coerce: parseCSV,
         default: []
+    })
+        .option('tags', {
+        describe: 'Only process projects with the given tag',
+        type: 'array',
+        coerce: parseCSV,
+        default: []
     })
         .options('only-failed', {
         describe: 'Isolate projects which previously failed',
diff --git a/node_modules/@nrwl/workspace/src/command-line/shared.js b/node_modules/@nrwl/workspace/src/command-line/shared.js
index f354aff..883fdbb 100644
--- a/node_modules/@nrwl/workspace/src/command-line/shared.js
+++ b/node_modules/@nrwl/workspace/src/command-line/shared.js
@@ -274,18 +274,21 @@ function readNxJson() {
     return config;
 }
 exports.readNxJson = readNxJson;
-exports.getAffected = function (affectedNamesFetcher) { return function (touchedFiles) {
+exports.getAffected = function (affectedNamesFetcher, tags = []) { return function (touchedFiles) {
     var workspaceJson = readWorkspaceJson();
     var nxJson = readNxJson();
     var projects = getProjectNodes(workspaceJson, nxJson);
     var implicitDeps = getImplicitDependencies(projects, workspaceJson, nxJson);
     var dependencies = deps_calculator_1.readDependencies(nxJson.npmScope, projects);
     var sortedProjects = topologicallySortProjects(projects, dependencies);
+    if (tags.length) {
+      sortedProjects = sortedProjects.filter(p => p.tags.some(t => tags.includes(t)));
+    }
     var tp = touched_1.touchedProjects(implicitDeps, projects, touchedFiles);
     return affectedNamesFetcher(sortedProjects, dependencies, tp);
 }; };
-function getAffectedProjectsWithTarget(target) {
-    return exports.getAffected(affected_apps_1.affectedProjectNamesWithTarget(target));
+function getAffectedProjectsWithTarget(target, tags = []) {
+    return exports.getAffected(affected_apps_1.affectedProjectNamesWithTarget(target), tags);
 }
 exports.getAffectedProjectsWithTarget = getAffectedProjectsWithTarget;
 exports.getAffectedApps = exports.getAffected(affected_apps_1.affectedAppNames);
@@ -303,12 +306,15 @@ function getAllProjectNamesWithTarget(target) {
     return getProjectNames(function (p) { return p.architect[target]; });
 }
 exports.getAllProjectNamesWithTarget = getAllProjectNamesWithTarget;
-function getAllProjectsWithTarget(target) {
+function getAllProjectsWithTarget(target, tags = []) {
     var workspaceJson = readWorkspaceJson();
     var nxJson = readNxJson();
     var projects = getProjectNodes(workspaceJson, nxJson);
     var dependencies = deps_calculator_1.readDependencies(nxJson.npmScope, projects);
     var sortedProjects = topologicallySortProjects(projects, dependencies);
+    if (tags.length) {
+      sortedProjects = sortedProjects.filter(p => p.tags.some(t => tags.includes(t)));
+    }
     return sortedProjects.filter(function (p) { return p.architect[target]; }).map(function (p) { return p.name; });
 }
 exports.getAllProjectsWithTarget = getAllProjectsWithTarget;

mehrad-rafigh · 2019-07-29T18:23:48Z

@alfaproject @wesleygrimes This looks like a start to a solution, which I would love to see in NX!

wesleygrimes · 2019-07-29T18:33:39Z

@alfaproject @wesleygrimes This looks like a start to a solution, which I would love to see in NX!

I am adding this ability, although I think we will go a slightly different route. I will reference the PR when it is submitted.

hoang-innomize · 2019-09-05T11:16:00Z

@wesleygrimes how it going with the feature that you have been working on to allow custom NX to ignore files/directories when running affected commands? I am working on CI/CD stuff for our repo and wanted to ignore files from affected to redeploy apps, such as I don't want to redeploy if I just updated my tslint.json file on the project root folder

wesleygrimes · 2019-09-05T11:18:10Z

@hoang-innomizetech Yes, you can now create an .nxignore file. This has been merged to master and should be available if not now, definitely in the next release.

hoang-innomize · 2019-09-05T11:23:27Z

I am using NX 8.4.13 and the .nxignore file is created but it seems not to work.

wesleygrimes · 2019-09-05T11:25:32Z

Can you file an issue please and provide a small reproduction with example nxignore file?

hoang-innomize · 2019-09-05T11:33:13Z

@wesleygrimes I think we have an open issue #895, release 8.4.13 included that issue but it still open

sroettering · 2019-09-17T12:21:38Z

@alfaproject @wesleygrimes This looks like a start to a solution, which I would love to see in NX!

I am adding this ability, although I think we will go a slightly different route. I will reference the PR when it is submitted.

Any update on this?

wickstargazer · 2020-02-11T11:54:44Z

Hi,

I saw there is a pullrequest for .nxignore --> PR #1585

However it only works for the workspace-lint command and not the affected commands

Can it be added in? I see that its added in the core/file-utils.ts in the function allFilesInDir

However thats only use in the workspace-lint as i observed.

Can we add the ignore machanism for the affected as well?

From what I observe there are several places this mechanism can be coded in, if someone would guide with me it would be great.

We either add a project level check with tags/flags at these functions

getTouchedProjects,
getImplicitlyTouchedProjects,
getImplicitlyTouchedProjectsByJsonChanges,
getTouchedProjectsInNxJson,
getTouchedProjectsInWorkspaceJson

Or we can go directly for the files using glob pattern in .nxignore

Either in shared.parseFiles after the git command are run
Or add directly into the file-utils.calculateFileChanges

I like the

add directly into the file-utils.calculateFileChanges

option the most. Please advise :D, If so can i work on it and open a PR?

johannesschobel · 2020-03-05T14:38:35Z

same here. I have the feeling, that the **/generated entry in my .nxignore file gets ignored (haha). In this case, the npm run affected:lint --fix --parallel --files=... command still tries to lint some auto-generated files (i.e., from a 3rd-party-codegen package). Obviously, this code is not lint-compliant and, therefore, cannot be committed properly :(

Does anyone have a solution for this?!

FrozenPandaz · 2020-05-29T19:16:17Z

Hi, sorry about this.

This was mislabeled as stale. We are testing ways to mark not reproducible issues as stale so that we can focus on actionable items but our initial experiment was too broad and unintentionally labeled this issue as stale.

github-actions · 2021-02-03T19:28:47Z

This issue has been automatically marked as stale because it hasn't had any recent activity. It will be closed in 14 days if no further activity occurs.
If we missed this issue please reply to keep it active.
Thanks for being a part of the Nx community! 🙏

mehrad-rafigh · 2021-02-08T09:03:05Z

Unstale

github-actions · 2021-03-29T15:11:30Z

This issue has been automatically marked as stale because it hasn't had any recent activity. It will be closed in 14 days if no further activity occurs.
If we missed this issue please reply to keep it active.
Thanks for being a part of the Nx community! 🙏

mehrad-rafigh · 2021-03-29T15:46:21Z

Still..unstale

alfaproject · 2021-03-29T16:11:04Z

Another 3 months and I've been patching for 2 years. I know I should have made a proper PR back then but the project grew in complexity and the direction of this request wasn't clear and probably still isn't clear. I'm not sure why tho, seems like such a valid feature.

We have some beefy GitLab instances to test stuff like the Angular projects which have their own tag, and then smaller GitLab instances to test all the node services and libraries that we have. It's much easier to just do yarn affected:test --tags=angular (it's more complex than this because we split this even further into multiple jobs per type but you get the idea)

mehrad-rafigh · 2021-04-06T08:19:14Z

Unstale...still

gagle · 2021-05-19T09:50:46Z

We can use the --exclude flag but this would be awesome to have...

github-actions · 2022-01-25T00:14:05Z

This issue has been automatically marked as stale because it hasn't had any recent activity. It will be closed in 14 days if no further activity occurs.
If we missed this issue please reply to keep it active.
Thanks for being a part of the Nx community! 🙏

alfaproject · 2022-01-25T09:26:00Z

I still want this feature and I actually wonder if this would be good enough for our use case: #8364

I haven't read the code yet but from the title it sounds like it could be good enough for us. I'll have a better look this week at that feature

ChristianBarrientos · 2022-04-21T03:35:31Z

Unstale...still

github-actions · 2022-12-28T00:21:27Z

This issue has been automatically marked as stale because it hasn't had any recent activity. It will be closed in 14 days if no further activity occurs.
If we missed this issue please reply to keep it active.
Thanks for being a part of the Nx community! 🙏

johannesschobel · 2022-12-28T08:00:21Z

Keep this issue alive

charleskoehl · 2023-03-29T10:21:54Z

I've created a workaround that partly addresses this issue. It allows me to conditionally execute nx-ignore depending on whether I include "nx-ignore" in the last commit message.

Let's say you have two apps you want to conditionally use nx-ignore with. Let's call them app1 and app2:

Create a vercel-pre-deploy.sh file in the root of your monorepo.

#!/bin/sh

if git log -1 --pretty=%B | grep -q 'nx-ignore'; then
  npx nx-ignore "$1"
else
  echo "Skipping nx-ignore step because 'nx-ignore' was not found in the commit message."
  exit 1
fi

In a terminal, execute chmod +x vercel-pre-deploy.sh in that directory.
In the "Ignored Build Step" field of the Git settings for each app, enter the following, respectively:
bash vercel-pre-deploy.sh app1
bash vercel-pre-deploy.sh app2
Now, whenever you want nx-ignore to be used by each app when you push a branch, just include nx-ignore somewhere in the last commit message.

github-actions · 2023-05-07T00:06:35Z

This issue has been closed for more than 30 days. If this issue is still occuring, please open a new issue with more recent context.

FrozenPandaz added the type: feature label Jul 27, 2019

FrozenPandaz assigned wesleygrimes Jul 27, 2019

mehrad-rafigh mentioned this issue Aug 6, 2019

[Feature Request] affected whitelist projects #1688

Closed

4 tasks

vsavkin changed the title ~~[Feature Request] Exclude Apps in affected scripts by tags from nx.json~~ Exclude Apps in affected scripts by tags from nx.json Dec 5, 2019

vsavkin unassigned wesleygrimes Dec 5, 2019

vsavkin added the scope: core core nx functionality label Dec 5, 2019

github-actions bot added the stale label May 29, 2020

FrozenPandaz removed the stale label May 29, 2020

nrwl deleted a comment from github-actions bot May 29, 2020

mehrad-rafigh mentioned this issue Jan 25, 2021

feat(core): exclude projects from affected based on tags #3812

Closed

github-actions bot added the stale label Feb 3, 2021

github-actions bot removed the stale label Feb 8, 2021

github-actions bot added the stale label Mar 29, 2021

github-actions bot removed the stale label Mar 29, 2021

github-actions bot added the stale label Jan 25, 2022

github-actions bot removed the stale label Jan 26, 2022

fguitton mentioned this issue May 1, 2022

feat(core): add support for tags with (print-)affected(:*) and run-many #10085

Merged

github-actions bot added the stale label Dec 28, 2022

github-actions bot removed the stale label Dec 29, 2022

AgentEnder closed this as completed in #10085 Apr 6, 2023

github-actions bot added the outdated label May 7, 2023

github-actions bot locked as resolved and limited conversation to collaborators May 7, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Exclude Apps in affected scripts by tags from nx.json #1621

Exclude Apps in affected scripts by tags from nx.json #1621

mehrad-rafigh commented Jul 24, 2019 •

edited

Loading

wesleygrimes commented Jul 26, 2019

mehrad-rafigh commented Jul 27, 2019

mehrad-rafigh commented Jul 27, 2019

alfaproject commented Jul 27, 2019

alfaproject commented Jul 28, 2019

mehrad-rafigh commented Jul 29, 2019 •

edited

Loading

wesleygrimes commented Jul 29, 2019

hoang-innomize commented Sep 5, 2019

wesleygrimes commented Sep 5, 2019

hoang-innomize commented Sep 5, 2019

wesleygrimes commented Sep 5, 2019

hoang-innomize commented Sep 5, 2019

sroettering commented Sep 17, 2019

wickstargazer commented Feb 11, 2020 •

edited

Loading

johannesschobel commented Mar 5, 2020

FrozenPandaz commented May 29, 2020

github-actions bot commented Feb 3, 2021

mehrad-rafigh commented Feb 8, 2021

github-actions bot commented Mar 29, 2021

mehrad-rafigh commented Mar 29, 2021

alfaproject commented Mar 29, 2021 •

edited

Loading

mehrad-rafigh commented Apr 6, 2021

gagle commented May 19, 2021

github-actions bot commented Jan 25, 2022

alfaproject commented Jan 25, 2022

ChristianBarrientos commented Apr 21, 2022

github-actions bot commented Dec 28, 2022

johannesschobel commented Dec 28, 2022

charleskoehl commented Mar 29, 2023

github-actions bot commented May 7, 2023

Exclude Apps in affected scripts by tags from nx.json #1621

Exclude Apps in affected scripts by tags from nx.json #1621

Comments

mehrad-rafigh commented Jul 24, 2019 • edited Loading

wesleygrimes commented Jul 26, 2019

mehrad-rafigh commented Jul 27, 2019

mehrad-rafigh commented Jul 27, 2019

alfaproject commented Jul 27, 2019

alfaproject commented Jul 28, 2019

mehrad-rafigh commented Jul 29, 2019 • edited Loading

wesleygrimes commented Jul 29, 2019

hoang-innomize commented Sep 5, 2019

wesleygrimes commented Sep 5, 2019

hoang-innomize commented Sep 5, 2019

wesleygrimes commented Sep 5, 2019

hoang-innomize commented Sep 5, 2019

sroettering commented Sep 17, 2019

wickstargazer commented Feb 11, 2020 • edited Loading

johannesschobel commented Mar 5, 2020

FrozenPandaz commented May 29, 2020

github-actions bot commented Feb 3, 2021

mehrad-rafigh commented Feb 8, 2021

github-actions bot commented Mar 29, 2021

mehrad-rafigh commented Mar 29, 2021

alfaproject commented Mar 29, 2021 • edited Loading

mehrad-rafigh commented Apr 6, 2021

gagle commented May 19, 2021

github-actions bot commented Jan 25, 2022

alfaproject commented Jan 25, 2022

ChristianBarrientos commented Apr 21, 2022

github-actions bot commented Dec 28, 2022

johannesschobel commented Dec 28, 2022

charleskoehl commented Mar 29, 2023

github-actions bot commented May 7, 2023

mehrad-rafigh commented Jul 24, 2019 •

edited

Loading

mehrad-rafigh commented Jul 29, 2019 •

edited

Loading

wickstargazer commented Feb 11, 2020 •

edited

Loading

alfaproject commented Mar 29, 2021 •

edited

Loading