bikecoders / ngx-deploy-npm Goto Github PK

Nx Devtik provide a wide set of tooling that we can use could leverage this project, making it easy to maintain and it would be more aligned into what a NxPlugin is.

There are new parameters on npm publish V7, workspace, and workspaces. Check npm publish docs for v7

Made a spike to see how we should implement those new parameters

Create a docker-compose.yml file to dockerize sonarqube for local development.

This is gonna improve the speed of sonar tweaking.

There are some of the commands used:

docker run \
    --rm \
    -e SONAR_HOST_URL="http://host.docker.internal:9000" \
    -v "`pwd`:/usr/src" \
    sonarsource/sonar-scanner-cli /bin/bash -c 'sonar-scanner \
        -Dsonar.host.url=$SONAR_HOST_URL \
        -Dsonar.login=local \
        -Dsonar.password=12345'

docker start sonarqube --interactive

docker run --name=sonarqube -p 9000:9000 sonarqube

Currently we offer support for Node V14, V16, V18

The description of the package is outdated

Make the change on the file to the new description

@JohannesHoppe had exposed several reasons why this needs to be changed to buildTarget:

• Configuration is misleading as it might be confused with configurations
• ng already has a --configuration parameter and is colliding with this one

I can enable auto increment version?
Example:
{
"version": "2.0.0"
}
nx deploy library --auto-increment
{
"version: "2.0.1"
}

Version 3.0.1 is not working properly on an Angular Workspace.

• ng add is working as expected. ✅
• ng deploy is causing errors ❌

.

Using [email protected]

When is running the main analysis, read the version from package.json and set it on the sonar analysis

LTS Node V12 end of life is on April 30. The next LTS will be V18, and its release date is April 19.

Wait until April 20 to modify the CI pipeline to drop v12 and adopt v18.

https://nodejs.org/en/about/releases/

## TODO

• Remove pr-test/unit-test (12) from required PR checks.
• Add pr-test/unit-test (18) to the required PR checks.

Right now, each time Nx releases a new version, we are generating a new version, but the changelog is empty, making it tricky to figure out what changed.

See the way to indicate to RenovateBot, to generate the right commit message to include it on the change log.

Hello! This is a feature request to get a configuration to ignore the following failure:

npm ERR! 400 Bad Request - PUT https://npm.pkg.github.com/@spaceribs%2fservice-window-ref - failed to stream package from json: unhandled input: Cannot publish over existing version.

The reason why is that I'm using this alongside: https://github.com/jscutlery/semver in an Nx monorepo, and changes that occur to say the top level package.json are not guaranteed to bump the package version. At the moment, I'm just ignoring errors for my final publishing step, but it would be much better if I could just ignore if the package already exists.

my repo: https://github.com/xmlking/ngx-starter-kit
when I run

ng deploy ngx-utils --dry-run

I am getting error.

according to angular/angular-cli#12290

the --prod is no longer needed as the library is always build in AOT mode and without the --prod it does clean the previous files as well.

Error

Error when trying to deploy:
Error: Configuration 'production' is not set in the workspace.
    at WorkspaceNodeModulesArchitectHost.getOptionsForTarget (/Developer/Work/SPA/ngx-starter-kit/node_modules/@angular-devkit/architect/node/node-modules-architect-host.js:72:19)
    at ArchitectTargetJobRegistry.get (/Developer/Work/SPA/ngx-starter-kit/node_modules/@angular-devkit/architect/src/architect.js:155:24)
    at MergeMapSubscriber.project (/Developer/Work/SPA/ngx-starter-kit/node_modules/@angular-devkit/core/src/experimental/jobs/fallback-registry.js:23:81)
    at MergeMapSubscriber._tryNext (/Developer/Work/SPA/ngx-starter-kit/node_modules/@angular-devkit/core/node_modules/rxjs/internal/operators/mergeMap.js:69:27)
    at MergeMapSubscriber._next (/Developer/Work/SPA/ngx-starter-kit/node_modules/@angular-devkit/core/node_modules/rxjs/internal/operators/mergeMap.js:59:18)
    at MergeMapSubscriber.Subscriber.next (/Developer/Work/SPA/ngx-starter-kit/node_modules/@angular-devkit/core/node_modules/rxjs/internal/Subscriber.js:66:18)
    at Observable._subscribe (/Developer/Work/SPA/ngx-starter-kit/node_modules/@angular-devkit/core/node_modules/rxjs/internal/util/subscribeToArray.js:5:20)
    at Observable._trySubscribe (/Developer/Work/SPA/ngx-starter-kit/node_modules/@angular-devkit/core/node_modules/rxjs/internal/Observable.js:44:25)
    at Observable.subscribe (/Developer/Work/SPA/ngx-starter-kit/node_modules/@angular-devkit/core/node_modules/rxjs/internal/Observable.js:30:22)
    at MergeMapOperator.call (/Developer/Work/SPA/ngx-starter-kit/node_modules/@angular-devkit/core/node_modules/rxjs/internal/operators/mergeMap.js:39:23)

my lib module in angular.json

    "ngx-utils": {
      "architect": {
        "build": {
          "builder": "@angular-devkit/build-ng-packagr:build",
          "options": {
            "project": "libs/ngx-utils/ng-package.json",
            "tsConfig": "libs/ngx-utils/tsconfig.lib.json"
          }
        },
        "lint": {
          "builder": "@angular-devkit/build-angular:tslint",
          "options": {
            "exclude": ["**/node_modules/**", "!libs/ngx-utils/**"],
            "tsConfig": ["libs/ngx-utils/tsconfig.lib.json", "libs/ngx-utils/tsconfig.spec.json"]
          }
        },
        "test": {
          "builder": "@nrwl/jest:jest",
          "options": {
            "jestConfig": "libs/ngx-utils/jest.config.js",
            "setupFile": "libs/ngx-utils/src/test-setup.ts",
            "tsConfig": "libs/ngx-utils/tsconfig.spec.json"
          }
        },
        "deploy": {
          "builder": "ngx-deploy-npm:deploy",
          "options": {
            "access": "public"
          }
        }
      },
      "prefix": "ngx",
      "projectType": "library",
      "root": "libs/ngx-utils",
      "sourceRoot": "libs/ngx-utils/src"
    },

How to reproduce

ng new my-project --create-application false
ng generate library my-lib
ng generate application my-app
ng add ngx-deploy-npm
ng deploy my-lib --dry-run 

Right now, we have almost an identical sonarqube job for pr analysis and main analysis.

Create a reusable workflow parameterized to be able to reuse it on PR's and Main analysis

I am trying to run this command inside an nx project:
nx run-many --all --target=deploy --no-build
But the --no-build flag wont pass to the command, but if I pass --noBuild it does work.

Currently, we support two types of libraries, the ones that have outputPath on build options and angular like libraries, the ones with the ngPackage to indicate the dist path.

This project can't publish the library if something goes slightly out of that. Let's add the ability to define a custom dist folder path

Let's prepare ourselves for incoming Nx changes and create a workflow to run unit and E2E tests with the nx @next version

With the introduction of husky, the npm link is broken.

Seems yarn link to work.

Do the test and update the docs to this method

Implement the plugin https://github.com/jscutlery/semver to manage versioning and changelog on this project

@edbzn, PR's are welcome

This tool is excellent at something real simple, grab a package and publish it to NPM.

When dealing with NPM packages, it's common to wonder how are going to be the versions generated but that it's something out of our scope. Semver does an excellent job at doing this, and it has a feature called post-targets that runs an executor after the version is generated. We are using that feature on this project

Write on the README, on the version-bumping section an invitation to use JSCutlery/semver

Providing the OTP by passing it through the CLI fails as the value provided is coerced into a number, rather than staying a string like the executor schema expects.

>  nx run utilities:deploy-npm --otp=634119
Property 'otp' does not match the schema. '634119' should be a 'string'.

As a workaround, I've patched the schema to expect a number and it works just fine.

Using Nx 14.3.6 and ngx-deploy-npm 4.1.2.

see angular-schule/angular-cli-ghpages#74

The deploy builder should stop the deploying process if the build breaks.

Broken:

Fixed:
https://github.com/angular-schule/ngx-deploy-starter/blob/f4d126c186c17f391d966d69e9526fdb1cd9908e/src/deploy/actions.ts#L51-L53

There is a misspelled word on the dry-run logger

Package it's being misspelled pacakge

Semver has a feature to be able to execute a target right after a release is made.

Documentation:
https://github.com/jscutlery/semver#post-targets
#73 (comment)

It's time to have a CI to run the test, build and, all that cool stuff that a CI brings. Let's start giving small steps implementing for the beginning only Continuous Integration to analyze the PR's after its integration to master.

This will found a solid ground to embrace more complex stuff like continuous deployment or continuous inspection with SonarQube.

We can get inspired by nx-migrate.yml workflow on semver project

Remove the e2e-test dependency from release-preliminar and put it to release.

We can start analyzing the release until we wait for the e2e tests to finish.

Example:
https://github.com/bikecoders/ngx-deploy-npm/actions/runs/2046894832

You are publishing versions, but it is not clear what changes have been done. I would use the "releases" section for that!

Cheers,
Johannes

Improve the current CI process on PRs to indicate how you would like the change log with the introduced commit message.

Remember: We do squash on the commit message, so the commit that would take into account would be the one that we set on the merge squash

A bot to comment on the PR seems to be a fun approach.

After upgrade to NX 14.2.4 getting:

Cannot find module 'nx/src/utils/app-root'
Require stack:
- /Users/nradulaski/code/hub/node_modules/ngx-deploy-npm/node_modules/@nrwl/devkit/index.js
- /Users/nradulaski/code/hub/node_modules/ngx-deploy-npm/src/executors/deploy/executor.js
- /Users/nradulaski/code/hub/node_modules/nx/src/config/workspaces.js
- /Users/nradulaski/code/hub/node_modules/nx/src/command-line/run.js
- /Users/nradulaski/code/hub/node_modules/nx/bin/run-executor.js

In NX app-root was renamed to workspace-root. @nrwl/devkit is locked to 14.0.5.

Having it ^14.0.5 should fix the issue.

We've been facing a lot of errors in the publishment workflow; #129 Seems to be the end of our headaches.

Leave this issue open remind ourselves to keep watching that process

Change the CI pipelines and the .nvmrc file to update Node to v18 when it becomes the primary LTS node.

According to Node Releases, this will happen on Oct 25 2022

Right now, we don't have visibility on how the changes affect an Angular Workspace in a real scenario.

The current e2e test already a good part of the functionality so these new tests could be very simple.
Maybe a bash script?

With the recent launches of Angular and Nx, this builder has been broken, we want to avoid this in the future. It will reduce maintenance time drastically.
To perform the test to verify that everything is working as expected is a tedious manual task that required time and concentration.
With the integration tests, we can verify that everything looks great with new releases of Angular and Nx.

We have a little experience on e2e tests but with front-end applications, do it for a library that integrates into a system is a completely new thing for me and I'm a little bit lost about which technologies and approaches take to realize this.

Hello there! 👋

I've been working on GitHub Actions configuration for my project and I've spent pretty much time figuring out why I'm getting npm ENEEDAUTH error.

npm ERR! code ENEEDAUTH
npm ERR! need auth This command requires you to be logged in to https://registry.yarnpkg.com/
npm ERR! need auth You need to authorize this machine using npm adduser

But after, I've found this comment in publishment.yml that helped me to solve this issue.

Use npx instead of yarn because yarn automagically sets NPM_* environment variables
like NPM_CONFIG_REGISTRY so npm publish ends up ignoring the .npmrc file
which is set up by setup-node action.

I think it would be really helpful to have GitHub Actions sample configuration in docs (I know there is one for CircleCI).
Or at least include that comment to CI/CD section in docs.

Besides that, I'm really grateful for this tool!

We don't need to update all the libs every week. There are only a few of them that we care about being up to date.

For example, we don't need to update @types/node every week, or ts-jest, jest, prettier, and so on. But we want the latest change of @nrwl/devkit, mainly because our CI will run the e2e test and see if everything is correct beforehand.

• Determine which packages we are interested in having recent updates
• Create a separate check interval for them the critical ones
• The rest of the dependencies, put them to check every month

Is it possible to commit version change on git, using a simple flag?

Is there any best practice about dealing with the changes if the deploy command is running in a CI/CD pipeline?

https://docs.npmjs.com/cli/v7/commands/npm-version

NPM version is automatically committing the change after patching the version, I would love to use this feature on the deploy command.

Is this feature already contained? And it is only mandatory to git push --tags?

Improve the current dist folder detection so in case of failure of the two existing methods, invite the user to use --dist-folder-path and to write us an issue to support the library

Would be great to be able to select projects we want to publish when running init schematic by adding an option --projects= project-a, project-b, what do you think?

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Awaiting Schedule

These updates are awaiting their schedule. Click on a checkbox to get an update now.

• build: 📦 casperwa/push-protected action to v2.16.0
• build: 📦 commitlint monorepo (@commitlint/cli, @commitlint/config-conventional)
• build: 📦 dependency @jscutlery/semver to v5.3.1
• build: 📦 dependency ts-jest to v29.2.5
• build: 📦 dependency tslib to v2.7.0
• build: 📦 jest monorepo (@types/jest, jest)
• build: 📦 typescript-eslint monorepo to v7.18.0 (@typescript-eslint/eslint-plugin, @typescript-eslint/parser)
• build: 📦 commitlint monorepo to v19 (major) (@commitlint/cli, @commitlint/config-conventional)
• build: 📦 dependency eslint to v9
• build: 📦 dependency husky to v9
• build: 📦 dependency prettier to v3
• build: 📦 dependency pretty-quick to v4
• build: 📦 github artifact actions to v4 (major) (actions/download-artifact, actions/upload-artifact)
• build: 📦 typescript-eslint monorepo to v8 (major) (@typescript-eslint/eslint-plugin, @typescript-eslint/parser)

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• build: 📦 dependency @types/node to v18.19.47
• build: 📦 nrwl monorepo to v19.6.4 (@nx/devkit, @nx/eslint, @nx/eslint-plugin, @nx/jest, @nx/js, @nx/plugin, @nx/workspace, create-nx-workspace, nx)
• build: 📦 dependency node to v20 (node, @types/node)
• chore: 📦 lock file maintenance
• Click on this checkbox to rebase all open PRs at once

Ignored or Blocked

These are blocked by an existing closed PR and will not be recreated unless you click a checkbox below.

• build: 📦 dependency prettier to v2.8.8
• build: 📦 dependency ts-node to v10.9.2
• build: 📦 dependency eslint-config-prettier to v9.1.0

Detected dependencies

• Check this box to trigger a request for Renovate to run again on this repository

Currently, the peerDendencies described on the package.json are not as accurate as they could be.

Take an example on the parent project ngx-deploy-starter to be more accurate.

The benefit of this change is mainly express explicit backward compatibility

When we try to init ngx-deploy-npm inside a non-Angular NX monorepo, I'm facing the following issue:

yarn  nx generate ngx-deploy-npm:init                                
yarn run v1.22.10
$ nx generate ngx-deploy-npm:init
Cannot find module '@angular-devkit/core'
Require stack:
- /Users/contoso/Projects/nx_react_monorepo/node_modules/@nrwl/tao/src/commands/ngcli-adapter.js
- /Users/contoso/Projects/nx_react_monorepo/node_modules/@nrwl/tao/src/commands/generate.js
- /Users/contoso/Projects/nx_react_monorepo/node_modules/@nrwl/tao/index.js
- /Users/contoso/Projects/nx_react_monorepo/node_modules/@nrwl/cli/lib/init-local.js
- /Users/contoso/Projects/nx_react_monorepo/node_modules/@nrwl/cli/bin/nx.js
error Command failed with exit code 1.
info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.

If ngx-deploy-npm is just a npm wrapper, why is it bounded to @angular-devkit/core?

The ngx-deploy-starter already fixed a bug relating to the ng add.

Do a cherry pick to bring that fix to our project

Now, the Angular E2E tests are only on the PR pipeline. Add them to the publishment workflow.

Consider adding those tests to basic tests or creating an action to reuse them on both workflows.

Create the possibility when doing install/ng-add to the user to change the default value of access which is currently public.

Because we removed some experimental APIs (promoted them as public in v11), the deployment builder no longer works.

It should be relatively easy to migrate. Here's an example from AngularFire angular/angularfire#2643.

Use the same nrwl workspace package version when installing the libraries generators.

Currently, it's installing the latest version available on NPM. This behavior leads to unwanted scenarios like analyzing breaking changes that are not currently supported for the source code.

Two things:

• Configurate githook on commit to run prettier on staged files
• On CI, verify if commits introduced ran prettier

Generate and add linter reports to sonarqube analysis