nx-affected-matrix

KO | EN

gitlite — search

#python #hacktoberfest #golang #machine-learning #deep-learning #linux #nodejs #windows #awesome #cli #vue #security #ios #open-source

nx-affected-matrix

(★ 10)

No description available.

nx-affected-matrix Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# @e-square/nx-affected-matrix

[![LATEST](https://img.shields.io/github/v/tag/e-square-io/nx-affected-matrix?style=flat-square&label=latest)]()
[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/e-square-io/nx-github-actions/main.yml?branch=main&event=push&logo=github&style=flat-square)](https://github.com/e-square-io/nx-github-actions/actions/workflows/main.yml)
[![Codecov](https://img.shields.io/codecov/c/github/e-square-io/nx-github-actions?logo=codecov&style=flat-square&token=PVPVUJAD1X)](https://app.codecov.io/gh/e-square-io/nx-github-actions)
[![All Contributors](https://img.shields.io/badge/all_contributors-2-orange.svg?style=flat-square)](https://github.com/e-square-io/nx-github-actions#contributors-)
[![MIT](https://img.shields.io/packagist/l/doctrine/orm.svg?style=flat-square)](https://github.com/e-square-io/nx-github-actions/blob/main/LICENSE)

## Summary

A GitHub Action that outputs a matrix of NX targets (with some other useful [outputs](#outputs).  
This action enables CI level parallelism by splitting the affected projects into multiple parallel jobs.

It is recommended to use this action's outputs with [@e-square/nx-distributed-task](https://github.com/marketplace/actions/nx-distributed-task),
check out the monorepo's [README](https://github.com/e-square-io/nx-github-actions#usage) for a full usage example of both actions.

## Usage

### Inputs

| name             | description                                                                                                                                 | default | required |
|:-----------------|:--------------------------------------------------------------------------------------------------------------------------------------------|:-------:|:--------:|
| targets          | Comma-delimited targets to run                                                                                                              |    -    | &check;  |
| maxDistribution  | Maximum distribution of jobs per target. Can be number that will be used for all targets, or an array/object that matches the targets input |    3    | &cross;  |
| workingDirectory | Path to the Nx workspace, needed if not the repository root                                                                                 |    -    | &cross;  |
| main-branch      | `nx-set-shas` action input. The 'main' branch of your repository (the base branch which you target with PRs)                                | 'main'  | &cross;  |
| workflow-id      | The ID of the github action workflow to check for successful run or the name of the file name containing the workflow                       |    -    | &cross;  |
| checkout         | Should the action do git checkout                                                                                                           |  true   | &cross;  |
| args             | Space-delimited args to add to nx `affected` command                                                                                        |    -    | &cross;  |

### Outputs

| name       | description                                                                     |
|:-----------|:--------------------------------------------------------------------------------|
| matrix     | The affected matrix to be consumed                                              |
| apps       | A comma-delimited list of the affected apps                                     |
| libs       | A comma-delimited list of the affected libs (including non buildable libs)      |
| hasChanges | boolean that will be true when there is at least one job in the affected matrix |

```yaml
jobs:
  setup:
    runs-on: ubuntu-latest
    name: Affected Matrix
    outputs:
      hasChanges: ${{ steps.affected.outputs.hasChanges }}
      matrix: ${{ steps.affected.outputs.matrix }}
    steps:
      - name: Calculate affected projects
        uses: e-square-io/nx-affected-matrix@v2
        id: affected
        with:
          targets: 'test,build'
          maxDistribution: 3
```

For each supplied target, the action will slice the list of affected projects into multiple groups.  
So the output matrix from the example above will be:

```json
{
  "include": [
    {
      "target": "test",
      "projects": "project1,project2"
    },
    {
      "target": "test",
      "projects": "project3,project4"
    },
    ...
  ]
}
```

### Control distribution per target

In some cases it might be useful to change the distribution only for a particular target.  
`maxDistribution` input can receive an object with keys matching to the supplied targets or an array that will match by index. e.g:

```yaml
- name: Calculate affected projects
  uses: e-square-io/nx-affected-matrix@v2
  id: affected
  with:
    targets: 'test,build'
    maxDistribution: '[2,1]' # or '{"test": 2, "build": 1}'
```

will produce 2 jobs for test target and one for build target.  
_Note: The action allows to set a partial distribution config, any target that isn't specified in the config will receive the default distribution value (3)_

## FAQ

**Q: Can I use this action without any prior actions? (checkout, npm ci, etc)**  
A: Yes! The action is already bundled with everything needed to run NX's affected command.  
Also, the action will do the checkout for you with `clean: false` & `fetch-depth: 0` (which is required in order to calculate the changes).

## Known Issues

1. **Cannot read properties of undefined (reading 'endsWith')**  
Workaround: make sure all of your projects has `root` defined in their `project.json` config file

nx-affected-matrix

nx-affected-matrix Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

nx-affected-matrix

nx-affected-matrix Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README