Skip to content

Commit dffb466

Browse files
dianjuardianjuar
committed
feat: remove internal build process
Deprecate the built-in build process in favor of `dependsOn` Nx feature. Add support for libraries that doesn't require build process. BREAKING CHANGE: - `ngx-deploy-npm:install`: Added `--dist-folder-path` option as required. - `ngx-deploy-npm:install`: Drop the option `--projects`, now, each project needs to be specified independently using `--project`. - `ngx-deploy-npm:deploy`: `distFolderPath` option is now required. - `ngx-deploy-npm:deploy`: Remove options `noBuild` and `buildTarget`.
1 parent e21fd4b commit dffb466

File tree

81 files changed

+4411
-2838
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

81 files changed

+4411
-2838
lines changed

‎.eslintrc.json

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,6 @@
33
"ignorePatterns": ["**/*"],
44
"plugins": ["@nx"],
55
"overrides": [
6-
{
7-
"files": ["package.json"],
8-
"parser": "jsonc-eslint-parser",
9-
"rules": {
10-
"@nx/dependency-checks": "error"
11-
}
12-
},
136
{
147
"files": ["*.ts", "*.tsx", "*.js", "*.jsx"],
158
"rules": {

‎.github/workflows/backwards-compatibility-test.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ on:
55
- cron: '0 0 * * *' # daily at 00:00
66

77
jobs:
8-
integration-test:
8+
backwards-compatibility-test:
99
strategy:
1010
matrix:
1111
nx-version: [latest, '16.10.0']

‎.github/workflows/basic-test.yml

Lines changed: 9 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,6 @@
11
name: Essential Test
22

3-
on:
4-
workflow_call:
5-
inputs:
6-
# Enable reports on workflow (lint and coverage)
7-
reports:
8-
type: boolean
9-
default: true
10-
required: false
3+
on: workflow_call
114

125
jobs:
136
lint:
@@ -17,14 +10,12 @@ jobs:
1710
- uses: ./.github/actions/setup
1811

1912
- name: Lint
20-
run: npx nx lint --outputFile=""
13+
run: npx nx lint ngx-deploy-npm
2114

22-
- if: inputs.reports == true
23-
name: Lint report
24-
run: npx nx lint --format=./tools/sonarqube-linter-reporter.js
15+
- name: Lint report
16+
run: npx nx lint-report ngx-deploy-npm
2517

26-
- if: inputs.reports == true
27-
name: Archive lint report results
18+
- name: Archive lint report results
2819
uses: actions/upload-artifact@v3
2920
with:
3021
name: lint-report-${{ github.sha }}
@@ -36,7 +27,7 @@ jobs:
3627
- uses: actions/checkout@v3
3728
- uses: ./.github/actions/setup
3829

39-
- run: npx nx build
30+
- run: npx nx build ngx-deploy-npm
4031

4132
- name: Archive build result
4233
uses: actions/upload-artifact@v3
@@ -53,9 +44,10 @@ jobs:
5344
- uses: actions/checkout@v3
5445
- uses: ./.github/actions/setup
5546

56-
- run: npx nx test --configuration="ci"
47+
- run: npx nx test ngx-deploy-npm --configuration="ci"
5748

58-
- name: Archive coverage report
49+
- if: ${{ matrix.os == 'ubuntu-latest' }}
50+
name: Archive coverage report
5951
uses: actions/upload-artifact@v3
6052
with:
6153
name: ngx-deploy-npm-coverage-report-${{ github.sha }}

‎.github/workflows/integration-test.yml

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ on:
66
nx-version:
77
type: string
88
description: The Nx Workspace version to run the integration test
9-
required: true
9+
required: false
1010

1111
jobs:
1212
integration-test:
@@ -15,5 +15,17 @@ jobs:
1515
- uses: actions/checkout@v3
1616
- uses: ./.github/actions/setup
1717

18+
- name: Read package.json Nx and set default parameter
19+
id: set-default-param
20+
run: |
21+
version=$(jq -r '.devDependencies.nx'package.json)
22+
if [ -z "${{ github.event.inputs.nx-version }}" ]; then
23+
echo "Setting default value for nx-version parameter: $version"
24+
echo "NX_VERSION=$version" >> $GITHUB_ENV
25+
else
26+
echo "Using provided value for nx-version parameter: ${{ github.event.inputs.nx-version }}"
27+
echo "NX_VERSION=${{ github.event.inputs.nx-version }}" >> $GITHUB_ENV
28+
fi
29+
1830
- name: Integration Test
19-
run: npx nx create-nx-workspace -- ${{ inputs.nx-version }}
31+
run: npx nx create-nx-workspace ngx-deploy-npm -- $NX_VERSION

‎.github/workflows/ci.yml renamed to ‎.github/workflows/pr.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,9 @@ jobs:
3636
- name: Check if Prettier was run
3737
run: npx pretty-quick --check
3838

39+
automated-manual-test:
40+
uses: ./.github/workflows/integration-test.yml
41+
3942
pr-analysis:
4043
name: SonarCloud Pr Analysis
4144
runs-on: ubuntu-latest

‎.github/workflows/publishment.yml

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

20+
automated-manual-test:
21+
uses: ./.github/workflows/integration-test.yml
22+
2023
analysis:
2124
name: SonarCloud Main Analysis
2225
runs-on: ubuntu-latest
@@ -43,12 +46,12 @@ jobs:
4346
- uses: ./.github/actions/setup
4447

4548
- name: Preliminar Version
46-
run: npx nx version --dry-run
49+
run: npx nx version ngx-deploy-npm --dry-run
4750

4851
release:
4952
environment: production
5053
runs-on: ubuntu-latest
51-
needs: [release-preliminar, e2e-test, test]
54+
needs: [release-preliminar, e2e-test, test, automated-manual-test]
5255
steps:
5356
- uses: actions/checkout@v3
5457
- uses: ./.github/actions/setup
@@ -70,7 +73,7 @@ jobs:
7073
# which is set up by `setup-node` action.
7174

7275
- name: Version and Publishment
73-
run: npx nx version
76+
run: npx nx version ngx-deploy-npm
7477
env:
7578
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
7679

‎.github/workflows/test-nx-next.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ jobs:
1414
with:
1515
nx-version: 'next'
1616
- name: Lint
17-
run: npx nx lint
17+
run: npx nx lint ngx-deploy-npm
1818

1919
build-next:
2020
runs-on: ubuntu-latest
@@ -25,7 +25,7 @@ jobs:
2525
with:
2626
nx-version: 'next'
2727
- name: Build
28-
run: npx nx build
28+
run: npx nx build ngx-deploy-npm
2929

3030
test-next:
3131
runs-on: ubuntu-latest
@@ -36,7 +36,7 @@ jobs:
3636
with:
3737
nx-version: 'next'
3838
- name: Test
39-
run: npx nx test
39+
run: npx nx test ngx-deploy-npm
4040

4141
e2e-next:
4242
runs-on: ubuntu-latest

‎.verdaccio/config.yml

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# path to a directory with all packages
2+
storage: ../tmp/local-registry/storage
3+
4+
# a list of other known repositories we can talk to
5+
uplinks:
6+
npmjs:
7+
url: https://registry.npmjs.org/
8+
maxage: 60m
9+
10+
packages:
11+
'**':
12+
# give all users (including non-authenticated users) full access
13+
# because it is a local registry
14+
access: $all
15+
publish: $all
16+
unpublish: $all
17+
18+
# if package is not available locally, proxy requests to npm registry
19+
proxy: npmjs
20+
21+
# log settings
22+
logs:
23+
type: stdout
24+
format: pretty
25+
level: warn
26+
27+
publish:
28+
allow_offline: true # set offline to true to allow publish offline

‎README.md

Lines changed: 20 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -85,14 +85,12 @@
8585

8686
- [🚀 Quick Start (local development)](#quick-start-local-development)
8787
- [🚀 Continuous Delivery](#continuous-delivery)
88-
- [❓What is done when executing `nx deploy`](#what-is-done-when-executing-nx-deploy)
8988
- [📦 Options](#options)
9089
- [install](#install)
91-
- [`--projects`](#--projects)
90+
- [`--dist-folder-path`](#--dist-folder-path-install)
91+
- [`--project`](#--project)
9292
- [`--access`](#--access-install)
9393
- [deploy](#deploy)
94-
- [`--build-target`](#--build-target)
95-
- [`--no-build`](#--no-build)
9694
- [`--package-version`](#--package-version)
9795
- [`--tag`](#--tag)
9896
- [`--access`](#--access)
@@ -173,63 +171,45 @@ jobs:
173171

174172
> You can check the steps suggested in the [CircleCI's guide](https://circleci.com/blog/publishing-npm-packages-using-circleci-2-0/)
175173
176-
## ❓What is done when executing `nx deploy` <a name="what-is-done-when-executing-nx-deploy"></a>
177-
178-
1. Will build the application using the target `build`
179-
- This will be omitted if the parameter `--no-build` is set
180-
2. Execute `npm publish`
174+
## 📦 Options <a name="options"></a>
181175
182-
The following is the activity diagram.
176+
### install
183177
184-
![Execution activity diagram](docs/UML/principal-activity-diagram.jpg)
178+
#### `--dist-folder-path` <a name="--dist-folder-path-install"></a>
185179
186-
## 📦 Options <a name="options"></a>
180+
- **required**
181+
- Example:
182+
- `nx generate ngx-deploy-npm:install --project=lib-1 --dist-folder-path="dist/libs/lib-1"`
187183
188-
### install
184+
Indicates the dist folder path. The path where is located the bundle of your library. The path should be relative to the project's root.
189185

190-
#### `--projects`
186+
#### `--project`
191187

192-
- **optional**
188+
- **required**
193189
- Example:
194-
- `nx generate ngx-deploy-npm:install --projects=lib-1,lib-2` – Only `lib-1` and `lib-2` are going to configure
190+
- `nx generate ngx-deploy-npm:install --project=lib-1 --dist-folder-path="dist/libs/lib-1"` – `lib-1` will be configured. It will create the target deploy with the default options on the project `lib-1`.
195191

196-
Specify which libraries should be configured. Useful when you have a workspace with several libraries and don't want to overwrite existing configuration
197-
Should be `,` separated, without spaces.
192+
Specify which library should be configured.
198193

199194
#### `--access` <a name="--access-install"></a>
200195

201196
- **optional**
202197
- Default: `public`
203198
- Example:
204-
- `nx generate ngx-deploy-npm:install --access=restricted`
199+
- `nx generate ngx-deploy-npm:install --access=restricted --project=lib-1 --dist-folder-path="dist/libs/lib-1"`
205200

206201
Tells the registry whether to publish the package as public or restricted. It only applies to scoped packages, which default to restricted. If you don't have a paid account, you must publish with --access public to publish scoped packages.
207202
208203
### deploy
209204
210-
#### `--build-target`
211-
212-
- **optional**
213-
- Example:
214-
- `nx deploy --build-target=production` – The configuration `production` is being used to build your package
215-
216-
The `buildTarget` points to an existing target configuration on your project,
217-
as specified in the `configurations` section of `workspace.json`.
218-
219-
This option is equivalent to calling the command `nx build --configuration=XXX`.
220-
This command has no effect if the option `--no-build` option is active.
221-
222-
#### `--no-build`
205+
#### `--dist-folder-path`
223206
224-
- **optional**
225-
- Default: `false` (string)
207+
- **required**
226208
- Example:
227-
- `nx deploy` – The library is built in production mode before the deployment
228-
- `nx deploy --no-build` – The library is NOT built, but the deployment process is being made
209+
- `nx deploy --dist-folder-path='dist/libs/my-project'`
229210
230-
Skip build process during deployment.
231-
This option is useful when the building process is handled by something else.
232-
This command causes the `--build-target` setting to have no effect.
211+
Indicate the dist folder path.
212+
The path must relative to project's root.
233213

234214
#### `--package-version`
235215

@@ -281,20 +261,11 @@ Configure npm to use any compatible registry you like, and even run your own reg
281261

282262
For testing: Run through without making any changes. Execute with `--dry-run`, and nothing will happen. It will show a list of the options used on the console.
283263

284-
#### `--dist-folder-path`
285-
286-
- **optional**
287-
- Example:
288-
- `nx deploy --dist-folder-path 'dist/my-unsupported-project'`
289-
290-
Indicate a custom dist folder path.
291-
The path must relative to project's root.
292-
Especially useful when ngx-deploy-npm can not detect your library dist folder path automatically. [Write us an issue](https://github.com/bikecoders/ngx-deploy-npm/issues/new) if you think we should support the library you are trying to publish
293-
294264
## Compatibility overview with Nx
295265

296266
| Version | Nx Workspace Version |
297267
| ------- | ---------------------- |
268+
| v8.0.0 | `^16.0.0 \|\| ^17.0.0` |
298269
| v7.1.0 | `^16.0.0 \|\| ^17.0.0` |
299270
| v7.0.1 | `^16.0.0` |
300271

‎docs/README_contributors.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ There are two ways of debugging:
6666

6767
#### Option A), the easy one
6868

69-
> ⚡ **Pre Step:** follow the steps of [yarn link](###angular-workspace) as pre step
69+
> ⚡ **Pre Step:** follow the steps of [yarn link](#angular-workspace) as pre step
7070
>
7171
> ⚠️ Only works on VsCode!
7272
@@ -77,7 +77,7 @@ On VsCode, create a [_JavaScript Debug Terminal_](https://code.visualstudio.com/
7777

7878
#### Option B), the traditional one
7979

80-
> ⚡ **Pre Step:** follow the steps of [yarn link](###angular-workspace) as pre step
80+
> ⚡ **Pre Step:** follow the steps of [yarn link](#angular-workspace) as pre step
8181
8282
1. Use your favorite [Inspector Client](https://nodejs.org/de/docs/guides/debugging-getting-started/#inspector-clients) to debug
8383

0 commit comments

Comments
 (0)