feat: publish npm package on npmjs.com registry (#3908)

Refs #3900
Refs #3907
Refs #3906
Refs #3901

Author: char0n

.github/workflows/docker-build-push.yml

@@ -44,6 +44,31 @@ jobs:
           mkdir build
           unzip build.zip -d build
 
+      - name: Determine released version
+        uses: actions/github-script@v6
+        with:
+          script: |
+            const allArtifacts = await github.rest.actions.listWorkflowRunArtifacts({
+               owner: context.repo.owner,
+               repo: context.repo.repo,
+               run_id: context.payload.workflow_run.id,
+            });
+            const matchArtifact = allArtifacts.data.artifacts.filter((artifact) => {
+              return artifact.name == "released-version"
+            })[0];
+            const download = await github.rest.actions.downloadArtifact({
+               owner: context.repo.owner,
+               repo: context.repo.repo,
+               artifact_id: matchArtifact.id,
+               archive_format: 'zip',
+            });
+            const fs = require('fs');
+            fs.writeFileSync('${{github.workspace}}/released-version.zip', Buffer.from(download.data));
+      - run: |
+          unzip released-version.zip
+          RELEASED_VERSION=$(cat released-version.txt)
+          echo "RELEASED_VERSION=RELEASED_VERSION" >> $GITHUB_ENV
+
       - name: Set up QEMU
         uses: docker/setup-qemu-action@v2
 
@@ -60,15 +85,15 @@ jobs:
         uses: docker/build-push-action@v4
         with:
           context: .
-          push: true
+          push: false
           platforms: linux/amd64,linux/arm/v6,linux/arm/v7,linux/arm64/v8,linux/386,linux/ppc64le,linux/s390x
-          tags: swaggerapi/swagger-editor:next-v5
+          tags: swaggerapi/swagger-editor:next-v5,swaggerapi/swagger-editor:v${{ env.RELEASED_VERSION }}
 
       - name: Build unprivileged docker image and push
         uses: docker/build-push-action@v4
         with:
           context: .
           file: Dockerfile.unprivileged
-          push: true
+          push: false
           platforms: linux/amd64,linux/arm/v6,linux/arm/v7,linux/arm64/v8,linux/386,linux/ppc64le,linux/s390x
-          tags: swaggerapi/swagger-editor:next-v5-unprivileged
+          tags: swaggerapi/swagger-editor:next-v5-unprivileged,swaggerapi/swagger-editor:v${{ env.RELEASED_VERSION }}-unprivileged

.github/workflows/release.yml

@@ -27,7 +27,6 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.SWAGGER_BOT_GITHUB_TOKEN }}
           NPM_TOKEN: ${{ secrets.SWAGGER_BOT_GITHUB_TOKEN }}
-          NODE_AUTH_TOKEN: ${{ secrets.SWAGGER_BOT_GITHUB_TOKEN }}
 
       - name: Nothing to release
         if: ${{ env.NEXT_RELEASE_VERSION == '' }}
@@ -44,28 +43,27 @@ jobs:
       - name: Install dependencies
         run: npm ci
 
-      - name: Prepare for the Release
-        env:
-          REACT_APP_VERSION: ${{ env.NEXT_RELEASE_VERSION }}
-        run: |
-          npm run lint
-          npm run test
-          npm run build:app
-          npm run cy:ci
-          npm run build:bundle:esm
-          npm run build:bundle:umd
+#      - name: Prepare for the Release
+#        env:
+#          REACT_APP_VERSION: ${{ env.NEXT_RELEASE_VERSION }}
+#        run: |
+#          npm run lint
+#          npm run test
+#          npm run build:app
+#          npm run cy:ci
+#          npm run build:bundle:esm
+#          npm run build:bundle:umd
 
       - name: Semantic Release
         id: semantic
         uses: cycjimmy/semantic-release-action@v3
         with:
-          dry_run: false
+          dry_run: true
           extra_plugins: |
             @semantic-release/git
         env:
           GITHUB_TOKEN: ${{ secrets.SWAGGER_BOT_GITHUB_TOKEN }}
           NPM_TOKEN: ${{ secrets.SWAGGER_BOT_GITHUB_TOKEN }}
-          NODE_AUTH_TOKEN: ${{ secrets.SWAGGER_BOT_GITHUB_TOKEN }}
 
       - name: Release failed
         if: steps.semantic.outputs.new_release_published == 'false'
@@ -86,3 +84,15 @@ jobs:
         with:
           name: build
           path: ./build
+
+
+      - name: Prepare released version for uploading
+        shell: bash
+        run: |
+          echo ${{ steps.semantic.outputs.new_release_version }} > released-version.txt
+      - name: Upload released version
+        uses: actions/upload-artifact@v3
+        with:
+          name: released-version
+          path: ./released-version.txt
+          retention-days: 1

.npmignore

@@ -20,6 +20,8 @@
 /.commitlintrc.json
 /cypress.config.js
 /Dockerfile
+/Dockerfile.unprivileged
 /.eslintrc
+/.gitattributes
 /.editorconfig
 /swagger-api-swagger-editor-*.tgz

README.md

@@ -32,49 +32,23 @@ These prerequisites are required both for installing SwaggerEditor as a npm pack
 ### Installation
 
 Assuming [prerequisites](#prerequisites) are already installed, SwaggerEditor npm package is installable and works with `Node.js >= 12.22.0`.
-SwaggerEditor npm package is currently hosted on [GitHub packages registry](https://docs.github.com/en/packages/learn-github-packages/introduction-to-github-packages).
-
-You can authenticate to GitHub Packages with npm by either editing your per-user *~/.npmrc*
-file to include your personal access token (classic) or by logging in to npm on the command line using your username and personal access token.
-
-To authenticate by adding your personal access token (classic) to your *~/.npmrc* file,
-edit the *~/.npmrc* file for your project to include the following line,
-replacing TOKEN with your personal access token. Create a new *~/.npmrc* file if one doesn't exist.
-You can find more information about authenticating to GitHub Packages in [GitHub documentation](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-npm-registry#authenticating-to-github-packages).
-
-Last step is to include a line to the *.npmrc* file, specifying GitHub Packages URL and the namespace *(@swagger-api)* where the package is hosted.
-
-```
-@swagger-api:registry=https://npm.pkg.github.com
-//npm.pkg.github.com/:_authToken=TOKEN
-```
-
-You can now install SwaggerEditor package using `npm`:
+You can install SwaggerEditor via [npm CLI](https://docs.npmjs.com/cli) by running the following command:
 
 ```sh
- $ npm install @swagger-api/swagger-editor
+ $ npm install swagger-editor@>=5
 ````
 
-For more information about installing npm packages from GitHub packages registry please visit [Installing a package](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-npm-registry#installing-a-package)
-section in GitHub documentation.
-
 ### Usage
 
-Install the package:
-
-```sh
- $ npm install @swagger-api/swagger-editor
-````
-
 Use the package in you application:
 
 **index.js**:
 
 ```js
 import React from 'react';
 import ReactDOM from 'react-dom';
-import SwaggerEditor from '@swagger-api/swagger-editor';
-import '@swagger-api/swagger-editor/swagger-editor.css';
+import SwaggerEditor from 'swagger-editor';
+import 'swagger-editor/swagger-editor.css';
 
 const url = "https://raw.githubusercontent.com/asyncapi/spec/v2.2.0/examples/streetlights-kafka.yml";
 
@@ -118,8 +92,8 @@ module.exports = {
   mode: 'production',
   entry: {
     app: './index.js',
-    'apidom.worker': '@swagger-api/swagger-editor/apidom.worker',
-    'editor.worker': '@swagger-api/swagger-editor/editor.worker',
+    'apidom.worker': 'swagger-editor/apidom.worker',
+    'editor.worker': 'swagger-editor/editor.worker',
   },
   output: {
     globalObject: 'self',
@@ -303,11 +277,11 @@ module.exports = {
     new CopyWebpackPlugin({
       patterns: [
         {
-          from: 'node_modules/@swagger-api/swagger-editor/dist/umd/apidom.worker.js',
+          from: 'node_modules/swagger-editor/dist/umd/apidom.worker.js',
           to: 'static/js',
         },
         {
-          from: 'node_modules/@swagger-api/swagger-editor/dist/umd/editor.worker.js',
+          from: 'node_modules/swagger-editor/dist/umd/editor.worker.js',
           to: 'static/js',
         }
       ]
@@ -452,7 +426,7 @@ It's bundled with React defined as external. This allows consumer to use his own
 
 **npm**
 
-SwaggerEditor is released as `@swagger-api/swagger-editor` npm package on [GitHub packages registry](https://docs.github.com/en/packages/learn-github-packages/introduction-to-github-packages).
+SwaggerEditor is released as `swagger-editor@5` npm package on [npmjs.com](https://npmjs.com).
 Package can also be produced manually by running following commands (assuming you're already followed [setting up](#setting-up) steps):
 
 ```sh
@@ -527,7 +501,7 @@ import React from 'react';
 import ReactDOM from 'react-dom';
 import SwaggerUI from 'swagger-ui-react';
 import 'swagger-ui-react/swagger-ui.css';
-import SwaggerEditor from '@swagger-api/swagger-editor';
+import SwaggerEditor from 'swagger-editor';
 
 const plugins = [
   SwaggerEditor.plugins.EditorContentType,

docs/customization/plug-points/editor-monaco.md

@@ -62,7 +62,7 @@ Static extension involves need to use a build system like webpack.
 **my-custom-apidom.worker.js**
 
 ```js
-import { initialize, makeCreate, ApiDOMWorker } from '@swagger-api/swagger-editor/apidom.worker';
+import { initialize, makeCreate, ApiDOMWorker } from 'swagger-editor/apidom.worker';
 
 class ApiDOMWorkerExtended extends ApiDOMWorker {
   // implementation of extensions
@@ -89,7 +89,7 @@ This is the part of the configuration that will change.
   entry: {
     app: './index.js',
     'apidom.worker': './my-custom-apidom.worker.js',
-    'editor.worker': '@swagger-api/swagger-editor/editor.worker',
+    'editor.worker': 'swagger-editor/editor.worker',
   }
 ```
 
@@ -146,7 +146,7 @@ Whenever you extend the `ApiDOMWorker` class you will have `_createData` public
 **my-custom-apidom.worker.js**
 
 ```js
-import { initialize, makeCreate, ApiDOMWorker } from '@swagger-api/swagger-editor/apidom.worker';
+import { initialize, makeCreate, ApiDOMWorker } from 'swagger-editor/apidom.worker';
 
 class ApiDOMWorkerExtended extends ApiDOMWorker {
   async loadData() {