Skip to content

Commit

Permalink
feat: drop support for Angular workspaces
Browse files Browse the repository at this point in the history
We have decided to stop supporting Angular Workspaces and focus exclusively on Nx Workspaces. This
decision is motivated by several factors, including the fact that the Nx Devkit no longer supports
compatibility with Angular Workspaces. To offer support, we would have to create a second plugin
that uses AngularDevkit under the hood, which would require considerable effort on the part of our
maintainers. We want to focus on what brings the most value to our current users, and Nx Workspaces
is the best way to do that.

BREAKING CHANGE: As an alternative, maintainers suggest migrating your Angular Workspaces to Nx
Workspaces if you want to use this plugin. A stand-alone approach to Nx workspaces is an option that
you should consider. We apologize for any inconvenience this may cause and appreciate your
understanding.

close #467
  • Loading branch information
dianjuar committed Nov 24, 2023
1 parent ebb701c commit 3fa9194
Show file tree
Hide file tree
Showing 19 changed files with 227 additions and 2,653 deletions.
1 change: 0 additions & 1 deletion .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ Please check if your PR fulfills the following requirements:

- [ ] Tests for the changes have been added (for bug fixes/features)
- [ ] Docs have been added/updated (for bug fixes/features)
- [ ] Both workspaces were tested Angular and Nx (for bug fixes/features)

## What is the current behavior?

Expand Down
23 changes: 0 additions & 23 deletions .github/workflows/angular-e2e-test.yml

This file was deleted.

4 changes: 0 additions & 4 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,3 @@ jobs:
with:
args: >
-Dsonar.pullrequest.key=${{ github.env.PR_NUMBER }}
angular-e2e-test:
needs: pr-test
uses: ./.github/workflows/angular-e2e-test.yml
4 changes: 0 additions & 4 deletions .github/workflows/publishment.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,6 @@ jobs:
if: ${{ !contains(github.event.head_commit.message, 'chore(release)') }}
uses: ./.github/workflows/integration-test-plugins.yml

angular-e2e-test:
needs: test
uses: ./.github/workflows/angular-e2e-test.yml

analysis:
name: SonarCloud Main Analysis
runs-on: ubuntu-latest
Expand Down
39 changes: 12 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,19 +79,17 @@

![Cover Image](docs/cover.png)

## Publish your libraries to NPM with one command on an Angular🅰️ or Nx🐬 workspace <!-- omit in toc -->

---
## Publish your libraries to NPM with one command <!-- omit in toc -->

**Table of contents:**

- [🚀 Quick Start (local development)](#quick-start-local-development)
- [🚀 Continuous Delivery](#continuous-delivery)
- [❓What is done when executing `nx deploy`](#what-is-done-when-executing-nx-deploy)
- [📦 Options](#options)
- [install/ng-add](#installng-add)
- [install](#install)
- [`--projects`](#--projects)
- [`--access`](#--access-ng-add-install)
- [`--access`](#--access-install)
- [deploy](#deploy)
- [`--build-target`](#--build-target)
- [`--no-build`](#--no-build)
Expand All @@ -111,27 +109,14 @@

---

> **Note:** all the examples are focused on Nx; if you don't see an
> explicit command for an Angular workspace change `nx` for `ng`.
>
> Also, when you find references to `workspace.json`, you can find your file under the name `angular.json`.
## 🚀 Quick Start (local development) <a name="quick-start-local-development"></a>

1. Add `ngx-deploy-npm` to your project. It will configure all your publishable libraries present in the project:

- Nx🐬

```bash
npm install --save-dev ngx-deploy-npm
nx generate ngx-deploy-npm:install
```

- Angular🅰️

```bash
ng add ngx-deploy-npm
```
```bash
npm install --save-dev ngx-deploy-npm
nx generate ngx-deploy-npm:install
```

2. Deploy your library to NPM with all default settings.

Expand Down Expand Up @@ -164,9 +149,9 @@ Independently of the CI/CD you are using, you need an NPM token. To do so, you h

- Create a step with:

| Nx🐬 | Angular🅰️ |
| :------------------------------------------ | :------------------------------------------ |
| <pre lang="sh">nx deploy your-library</pre> | <pre lang="sh">ng deploy your-library</pre> |
```sh
nx deploy your-library
```

5. Enjoy your just-released package 🎉📦

Expand Down Expand Up @@ -200,7 +185,7 @@ The following is the activity diagram.
## 📦 Options <a name="options"></a>
### install/ng-add
### install
#### `--projects`
Expand All @@ -211,7 +196,7 @@ The following is the activity diagram.
Specify which libraries should be configured. Useful when you have a workspace with several libraries and don't want to overwrite existing configuration
Should be `,` separated, without spaces.

### `--access` <a name="--access-ng-add-install"></a>
#### `--access` <a name="--access-install"></a>

- **optional**
- Default: `public`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import {
installNgxDeployNPMProject,
} from '../utils';

describe('install/ng-add', () => {
describe('install', () => {
const publicLib = 'node-lib1';
let projectWorkSpacepublicLib: ProjectConfiguration;

Expand Down
Loading

0 comments on commit 3fa9194

Please sign in to comment.