Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mansagroup/nrwl-nx-action
A GitHub Action to wrap Nrwl Nx commands in your workflows.
https://github.com/mansagroup/nrwl-nx-action
actions affected dependency-graph github-action github-actions graph monorepo nrwl nrwl-nx nx pull-request workflows
Last synced: 4 days ago
JSON representation
A GitHub Action to wrap Nrwl Nx commands in your workflows.
- Host: GitHub
- URL: https://github.com/mansagroup/nrwl-nx-action
- Owner: MansaGroup
- License: mit
- Created: 2020-09-02T15:34:32.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2023-07-07T18:37:06.000Z (about 1 year ago)
- Last Synced: 2024-09-20T17:02:11.330Z (13 days ago)
- Topics: actions, affected, dependency-graph, github-action, github-actions, graph, monorepo, nrwl, nrwl-nx, nx, pull-request, workflows
- Language: TypeScript
- Homepage:
- Size: 2.37 MB
- Stars: 223
- Watchers: 3
- Forks: 19
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Nrwl Nx Action
  
The action wraps the usage of the [Nrwl Nx](https://nx.dev/) monorepo development toolkit.
Nx manages multiple **projects** linked each other with a dependecy graph. One of its key
features is to permit to run one or more **tasks** only on the projects affected by our
changes (by checking the difference between two Git references).
GitHub Action's workflows provide some information about the Git references concerned
by the workflow, in a _pull request context_, we have the current commit and the last
one from the base branch. Combined with Nx, we can determine the projects affected
by the whole pull request.
> It's more than useful in a **CI/CD** context: we are able to _lint_, _build_ and _deploy_
> only the projects affected by a _pull request_ for instance.
Copy-pasting the bash code to compute the reference bounds for Nx is not that
maintenable. That's why we are open-sourcing this action to do the trick for you.
## Usage
By default, the action will try to run the provided tasks only on the affected projects.
This behavior can be modified using the different inputs (see below).
> workflow.yml
```yaml
---
- name: Checkout
uses: actions/checkout@v3
with:
fetch-depth: 0
- uses: mansagroup/nrwl-nx-action@v3
with:
targets: lint,build,deploy
```
This simple step will run three targets: `lint`, `build` and `deploy`, sequentially
only on the affected projects. Nothing more. Simple. More examples below.
> Note:
> By default, the checkout action will only clone the latest commit of the branch,
> which will cause issues as Nx needs to compute the difference between the `base`
> and `head`. Using the `fetch-depth: 0` parameter will clone the entire
> repository, which is not optimal but functional.
## Inputs
This GitHub action can take several inputs to configure its behaviors:
| Name | Type | Default | Example | Description |
| ---------------- | -------------------- | ------- | ------------------ | ---------------------------------------------------------------------------------- |
| targets | Comma-separated list | ø | `lint,test,build` | List of targets to execute |
| projects | Comma-separated list | ø | `frontend,backend` | List of projects to use (more below) |
| all | Boolean | `false` | `true` | Run the targets on all the projects of the Nx workspace |
| affected | Boolean | `true` | `true` | Run the targets on the affected projects since the last modifications (more below) |
| parallel | Number | `3` | `3` | Number of tasks to execute in parallel (can be expensive) |
| args | String | ø | `--key="value"` | Optional args to append to the Nx commands |
| nxCloud | Boolean | `false` | `true` | Enable support of Nx Cloud |
| workingDirectory | String | ø | `myNxFolder` | Path to the Nx workspace, needed if not the repository root |
**Note:** `all` and `affected` are mutually exclusive.
### `projects`
When defined, will skip the `all` and `affected` inputs.
### `affected`
When set to `true`, the affected detection will depend on the event type
of the workflow:
- Inside a **pull request** context, the action will use the base and head Git
references
- Otherwise, will compute the difference between the `HEAD` and the last
commit
## Examples
### Run one target on all the affected projects (default)
This will run the `build` target on all the affected projects.
**This is the default behavior.**
> workflow.yml
```yaml
---
- uses: mansagroup/nrwl-nx-action@v3
with:
targets: build
affected: 'true' # Defaults to true, therefore optional
```
### Run multiple targets to all projects
This will run three targets: `lint`, `test` and `build` to all the
projects of the workspace.
> workflow.yml
```yaml
---
- uses: mansagroup/nrwl-nx-action@v3
with:
targets: lint,test,build
all: 'true'
```
### Run one target on some projects
This will run the `build` target on the `frontend` and `backend` projects
only.
> workflow.yml
```yaml
---
- uses: mansagroup/nrwl-nx-action@v3
with:
targets: build
projects: frontend,backend
```
### Run one target on all the projects sequentially
This will run the `lint` target on all the projects of the workspace
sequentially.
> workflow.yml
```yaml
---
- uses: mansagroup/nrwl-nx-action@v3
with:
targets: lint
all: 'true'
parallel: 1
```
### Run one target on a Nx workspace located in another folder
This will run the `build` target on all the affected projects of a
Nx workspace located in another folder than the repository root.
> workflow.yml
```yaml
---
- uses: mansagroup/nrwl-nx-action@v3
with:
targets: build
workingDirectory: my-nx-subfolder
```
### Run one target with Nx Cloud enabled
This will run the `build` target on all the affected projects with
Nx Cloud enabled (by adding the `--scan` command option and both
`NX_BRANCH` and `NX_RUN_GROUP` environment variables).
> workflow.yml
```yaml
---
- uses: mansagroup/nrwl-nx-action@v3
with:
targets: build
nxCloud: 'true'
```
## License
This project is [MIT licensed](LICENSE.txt).
## Contributors
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
