Skip to content

Commit af95f44

Browse files
authored
feat: drop support for Angular workspaces (#570)
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.
1 parent 1072a85 commit af95f44

File tree

19 files changed

+227
-2655
lines changed

19 files changed

+227
-2655
lines changed

.github/pull_request_template.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@ Please check if your PR fulfills the following requirements:
44

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

98
## What is the current behavior?
109

.github/workflows/angular-e2e-test.yml

Lines changed: 0 additions & 23 deletions
This file was deleted.

.github/workflows/ci.yml

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,3 @@ jobs:
5757
with:
5858
args: >
5959
-Dsonar.pullrequest.key=${{ github.env.PR_NUMBER }}
60-
61-
angular-e2e-test:
62-
needs: pr-test
63-
uses: ./.github/workflows/angular-e2e-test.yml

.github/workflows/publishment.yml

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,6 @@ jobs:
1717
if: ${{ !contains(github.event.head_commit.message, 'chore(release)') }}
1818
uses: ./.github/workflows/integration-test-plugins.yml
1919

20-
angular-e2e-test:
21-
needs: test
22-
uses: ./.github/workflows/angular-e2e-test.yml
23-
2420
analysis:
2521
name: SonarCloud Main Analysis
2622
runs-on: ubuntu-latest

README.md

Lines changed: 12 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -79,19 +79,17 @@
7979

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

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

8684
**Table of contents:**
8785

8886
- [🚀 Quick Start (local development)](#quick-start-local-development)
8987
- [🚀 Continuous Delivery](#continuous-delivery)
9088
- [❓What is done when executing `nx deploy`](#what-is-done-when-executing-nx-deploy)
9189
- [📦 Options](#options)
92-
- [install/ng-add](#installng-add)
90+
- [install](#install)
9391
- [`--projects`](#--projects)
94-
- [`--access`](#--access-ng-add-install)
92+
- [`--access`](#--access-install)
9593
- [deploy](#deploy)
9694
- [`--build-target`](#--build-target)
9795
- [`--no-build`](#--no-build)
@@ -111,27 +109,14 @@
111109

112110
---
113111

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

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

123-
- Nx🐬
124-
125-
```bash
126-
npm install --save-dev ngx-deploy-npm
127-
nx generate ngx-deploy-npm:install
128-
```
129-
130-
- Angular🅰️
131-
132-
```bash
133-
ng add ngx-deploy-npm
134-
```
116+
```bash
117+
npm install --save-dev ngx-deploy-npm
118+
nx generate ngx-deploy-npm:install
119+
```
135120

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

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

165150
- Create a step with:
166151

167-
| Nx🐬 | Angular🅰️ |
168-
| :------------------------------------------ | :------------------------------------------ |
169-
| <pre lang="sh">nx deploy your-library</pre> | <pre lang="sh">ng deploy your-library</pre> |
152+
```sh
153+
nx deploy your-library
154+
```
170155

171156
5. Enjoy your just-released package 🎉📦
172157

@@ -200,7 +185,7 @@ The following is the activity diagram.
200185
201186
## 📦 Options <a name="options"></a>
202187
203-
### install/ng-add
188+
### install
204189
205190
#### `--projects`
206191
@@ -211,7 +196,7 @@ The following is the activity diagram.
211196
Specify which libraries should be configured. Useful when you have a workspace with several libraries and don't want to overwrite existing configuration
212197
Should be `,` separated, without spaces.
213198

214-
### `--access` <a name="--access-ng-add-install"></a>
199+
#### `--access` <a name="--access-install"></a>
215200

216201
- **optional**
217202
- Default: `public`

e2e/ngx-deploy-npm-e2e/tests/install-ng-add.spec.ts renamed to e2e/ngx-deploy-npm-e2e/tests/install.spec.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import {
1010
installNgxDeployNPMProject,
1111
} from '../utils';
1212

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

0 commit comments

Comments
 (0)