Skip to content

Commit 4fea662

Browse files
authored
Refs #3897 Closes #3891 Closes #3884
1 parent b9124ac commit 4fea662

File tree

7 files changed

+835
-830
lines changed

7 files changed

+835
-830
lines changed

.github/workflows/build.yml

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,6 @@ jobs:
2222
uses: actions/setup-node@v3
2323
with:
2424
node-version: 16.16
25-
registry-url: https://npm.pkg.github.com/
26-
scope: "@swagger-api"
2725

2826
- name: Cache npm cache files
2927
id: cache-npm-cache-files
@@ -40,8 +38,6 @@ jobs:
4038

4139
- name: Install dependencies
4240
run: npm ci
43-
env:
44-
NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
4541

4642
- name: Lint commit message
4743
if: github.ref != 'refs/heads/next' && github.actor != 'dependabot[bot]'

.github/workflows/nightly-build.yml

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,6 @@ jobs:
2323
uses: actions/setup-node@v3
2424
with:
2525
node-version: 16.16
26-
registry-url: https://npm.pkg.github.com/
27-
scope: "@swagger-api"
2826

2927
- name: Cache npm cache files
3028
id: cache-npm-cache-files
@@ -41,8 +39,6 @@ jobs:
4139

4240
- name: Install dependencies
4341
run: npm ci
44-
env:
45-
NODE_AUTH_TOKEN: ${{ secrets.SWAGGER_BOT_GITHUB_TOKEN }}
4642

4743
- name: Lint code
4844
run: npm run lint

.github/workflows/release.yml

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,6 @@ jobs:
1717
submodules: true
1818
ref: next
1919

20-
- name: Setup Node.js
21-
uses: actions/setup-node@v3
22-
with:
23-
node-version: 16
24-
registry-url: https://npm.pkg.github.com/
25-
scope: "@swagger-api"
26-
2720
- name: Determine the next release version
2821
uses: cycjimmy/semantic-release-action@v3
2922
with:
@@ -43,10 +36,13 @@ jobs:
4336
script: |
4437
core.setFailed('Nothing to release')
4538
39+
- name: Setup Node.js
40+
uses: actions/setup-node@v3
41+
with:
42+
node-version: 16
43+
4644
- name: Install dependencies
4745
run: npm ci
48-
env:
49-
NODE_AUTH_TOKEN: ${{ secrets.SWAGGER_BOT_GITHUB_TOKEN }}
5046

5147
- name: Prepare for the Release
5248
env:

.npmrc

Lines changed: 0 additions & 1 deletion
This file was deleted.

README.md

Lines changed: 64 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -141,6 +141,38 @@ module.exports = {
141141
'monaco-editor$': 'monaco-editor/esm/vs/editor/edcore.main.js',
142142
// This alias make sure we don't pull two different versions of monaco-editor
143143
'monaco-editor': '/node_modules/monaco-editor',
144+
// This alias makes sure we don't pull two different versions of ApiDOM.
145+
// swagger-client uses ApiDOM as well, and might come with different ApiDOM version.
146+
// SwaggerEditor ApiDOM dependency takes precendence in the resolution.
147+
'@swagger-api/apidom-ast$': '/node_modules/@swagger-api/apidom-ast/es/index.js',
148+
'@swagger-api/apidom-core$': '/node_modules/@swagger-api/apidom-core/es/index.js',
149+
'@swagger-api/apidom-json-pointer$': '/node_modules/@swagger-api/apidom-json-pointer/es/index.js',
150+
'@swagger-api/apidom-ls$': '/node_modules/@swagger-api/apidom-ls/es/index.js',
151+
'@swagger-api/apidom-ns-api-design-systems$': '/node_modules/@swagger-api/apidom-ns-api-design-systems/es/index.js',
152+
'@swagger-api/apidom-ns-asyncapi-2$': '/node_modules/@swagger-api/apidom-ns-asyncapi-2/es/index.js',
153+
'@swagger-api/apidom-ns-json-schema-draft-4$': '/node_modules/@swagger-api/apidom-ns-json-schema-draft-4/es/index.js',
154+
'@swagger-api/apidom-ns-json-schema-draft-6$': '/node_modules/@swagger-api/apidom-ns-json-schema-draft-6/es/index.js',
155+
'@swagger-api/apidom-ns-json-schema-draft-7$': '/node_modules/@swagger-api/apidom-ns-json-schema-draft-7/es/index.js',
156+
'@swagger-api/apidom-ns-openapi-3-0$': '/node_modules/@swagger-api/apidom-ns-openapi-3-0/es/index.js',
157+
'@swagger-api/apidom-ns-openapi-3-1$': '/node_modules/@swagger-api/apidom-ns-openapi-3-1/es/index.js',
158+
'@swagger-api/apidom-parser$': '/node_modules/@swagger-api/apidom-parser/es/parser.js',
159+
'@swagger-api/apidom-parser-adapter-api-design-systems-json$': '/node_modules/@swagger-api/apidom-parser-adapter-api-design-systems-json/es/adapter.js',
160+
'@swagger-api/apidom-parser-adapter-api-design-systems-yaml$': '/node_modules/@swagger-api/apidom-parser-adapter-api-design-systems-yaml/es/adapter.js',
161+
'@swagger-api/apidom-parser-adapter-asyncapi-json-2$': '/node_modules/@swagger-api/apidom-parser-adapter-asyncapi-json-2/es/adapter.js',
162+
'@swagger-api/apidom-parser-adapter-asyncapi-yaml-2$': '/node_modules/@swagger-api/apidom-parser-adapter-asyncapi-yaml-2/es/adapter.js',
163+
'@swagger-api/apidom-parser-adapter-json$': '/node_modules/@swagger-api/apidom-parser-adapter-json/es/adapter-browser.js',
164+
'@swagger-api/apidom-parser-adapter-openapi-json-3-0$': '/node_modules/@swagger-api/apidom-parser-adapter-openapi-json-3-0/es/adapter.js',
165+
'@swagger-api/apidom-parser-adapter-openapi-json-3-1$': '/node_modules/@swagger-api/apidom-parser-adapter-openapi-json-3-1/es/adapter.js',
166+
'@swagger-api/apidom-parser-adapter-openapi-yaml-3-0$': '/node_modules/@swagger-api/apidom-parser-adapter-openapi-yaml-3-0/es/adapter.js',
167+
'@swagger-api/apidom-parser-adapter-openapi-yaml-3-1$': '/node_modules/@swagger-api/apidom-parser-adapter-openapi-yaml-3-1/es/adapter.js',
168+
'@swagger-api/apidom-parser-adapter-yaml-1-2$': '/node_modules/@swagger-api/apidom-parser-adapter-yaml-1-2/es/adapter-browser.js',
169+
'@swagger-api/apidom-reference$': '/node_modules/@swagger-api/apidom-reference/es/index.js',
170+
'@swagger-api/apidom-reference/configuration/empty$': '/node_modules/@swagger-api/apidom-reference/es/configuration/empty.js',
171+
'@swagger-api/apidom-reference/resolve/strategies/openapi-3-1$': '/node_modules/@swagger-api/apidom-reference/es/resolve/strategies/openapi-3-1/index.js',
172+
'@swagger-api/apidom-reference/parse/parsers/binary$': '/node_modules/@swagger-api/apidom-reference/es/parse/parsers/binary/index-browser.js',
173+
'@swagger-api/apidom-reference/dereference/strategies/openapi-3-1/selectors/$anchor$': '/node_modules/@swagger-api/apidom-reference/es/dereference/strategies/openapi-3-1/selectors/$anchor/index.js',
174+
'@swagger-api/apidom-reference/dereference/strategies/openapi-3-1/selectors/uri$': '/node_modules/@swagger-api/apidom-reference/es/dereference/strategies/openapi-3-1/selectors/uri/index.js',
175+
'@swagger-api/apidom-reference/dereference/strategies/openapi-3-1$': '/node_modules/@swagger-api/apidom-reference/es/dereference/strategies/openapi-3-1/index.js',
144176
},
145177
},
146178
plugins: [
@@ -229,6 +261,38 @@ module.exports = {
229261
'monaco-editor$': 'monaco-editor/esm/vs/editor/edcore.main.js',
230262
// This alias make sure we don't pull two different versions of monaco-editor
231263
'monaco-editor': '/node_modules/monaco-editor',
264+
// This alias makes sure we don't pull two different versions of ApiDOM.
265+
// swagger-client uses ApiDOM as well, and might come with different ApiDOM version.
266+
// SwaggerEditor ApiDOM dependency takes precendence in the resolution.
267+
'@swagger-api/apidom-ast$': '/node_modules/@swagger-api/apidom-ast/es/index.js',
268+
'@swagger-api/apidom-core$': '/node_modules/@swagger-api/apidom-core/es/index.js',
269+
'@swagger-api/apidom-json-pointer$': '/node_modules/@swagger-api/apidom-json-pointer/es/index.js',
270+
'@swagger-api/apidom-ls$': '/node_modules/@swagger-api/apidom-ls/es/index.js',
271+
'@swagger-api/apidom-ns-api-design-systems$': '/node_modules/@swagger-api/apidom-ns-api-design-systems/es/index.js',
272+
'@swagger-api/apidom-ns-asyncapi-2$': '/node_modules/@swagger-api/apidom-ns-asyncapi-2/es/index.js',
273+
'@swagger-api/apidom-ns-json-schema-draft-4$': '/node_modules/@swagger-api/apidom-ns-json-schema-draft-4/es/index.js',
274+
'@swagger-api/apidom-ns-json-schema-draft-6$': '/node_modules/@swagger-api/apidom-ns-json-schema-draft-6/es/index.js',
275+
'@swagger-api/apidom-ns-json-schema-draft-7$': '/node_modules/@swagger-api/apidom-ns-json-schema-draft-7/es/index.js',
276+
'@swagger-api/apidom-ns-openapi-3-0$': '/node_modules/@swagger-api/apidom-ns-openapi-3-0/es/index.js',
277+
'@swagger-api/apidom-ns-openapi-3-1$': '/node_modules/@swagger-api/apidom-ns-openapi-3-1/es/index.js',
278+
'@swagger-api/apidom-parser$': '/node_modules/@swagger-api/apidom-parser/es/parser.js',
279+
'@swagger-api/apidom-parser-adapter-api-design-systems-json$': '/node_modules/@swagger-api/apidom-parser-adapter-api-design-systems-json/es/adapter.js',
280+
'@swagger-api/apidom-parser-adapter-api-design-systems-yaml$': '/node_modules/@swagger-api/apidom-parser-adapter-api-design-systems-yaml/es/adapter.js',
281+
'@swagger-api/apidom-parser-adapter-asyncapi-json-2$': '/node_modules/@swagger-api/apidom-parser-adapter-asyncapi-json-2/es/adapter.js',
282+
'@swagger-api/apidom-parser-adapter-asyncapi-yaml-2$': '/node_modules/@swagger-api/apidom-parser-adapter-asyncapi-yaml-2/es/adapter.js',
283+
'@swagger-api/apidom-parser-adapter-json$': '/node_modules/@swagger-api/apidom-parser-adapter-json/es/adapter-browser.js',
284+
'@swagger-api/apidom-parser-adapter-openapi-json-3-0$': '/node_modules/@swagger-api/apidom-parser-adapter-openapi-json-3-0/es/adapter.js',
285+
'@swagger-api/apidom-parser-adapter-openapi-json-3-1$': '/node_modules/@swagger-api/apidom-parser-adapter-openapi-json-3-1/es/adapter.js',
286+
'@swagger-api/apidom-parser-adapter-openapi-yaml-3-0$': '/node_modules/@swagger-api/apidom-parser-adapter-openapi-yaml-3-0/es/adapter.js',
287+
'@swagger-api/apidom-parser-adapter-openapi-yaml-3-1$': '/node_modules/@swagger-api/apidom-parser-adapter-openapi-yaml-3-1/es/adapter.js',
288+
'@swagger-api/apidom-parser-adapter-yaml-1-2$': '/node_modules/@swagger-api/apidom-parser-adapter-yaml-1-2/es/adapter-browser.js',
289+
'@swagger-api/apidom-reference$': '/node_modules/@swagger-api/apidom-reference/es/index.js',
290+
'@swagger-api/apidom-reference/configuration/empty$': '/node_modules/@swagger-api/apidom-reference/es/configuration/empty.js',
291+
'@swagger-api/apidom-reference/resolve/strategies/openapi-3-1$': '/node_modules/@swagger-api/apidom-reference/es/resolve/strategies/openapi-3-1/index.js',
292+
'@swagger-api/apidom-reference/parse/parsers/binary$': '/node_modules/@swagger-api/apidom-reference/es/parse/parsers/binary/index-browser.js',
293+
'@swagger-api/apidom-reference/dereference/strategies/openapi-3-1/selectors/$anchor$': '/node_modules/@swagger-api/apidom-reference/es/dereference/strategies/openapi-3-1/selectors/$anchor/index.js',
294+
'@swagger-api/apidom-reference/dereference/strategies/openapi-3-1/selectors/uri$': '/node_modules/@swagger-api/apidom-reference/es/dereference/strategies/openapi-3-1/selectors/uri/index.js',
295+
'@swagger-api/apidom-reference/dereference/strategies/openapi-3-1$': '/node_modules/@swagger-api/apidom-reference/es/dereference/strategies/openapi-3-1/index.js',
232296
}
233297
},
234298
plugins: [
@@ -276,34 +340,6 @@ will automatically pick the right Node.js version for you:
276340
$ nvm use
277341
```
278342
279-
This repository is using npm packages from [https://www.npmjs.com/](npmjs.com) and [GitHub packages registry](https://docs.github.com/en/packages/learn-github-packages/introduction-to-github-packages).
280-
To successfully install npm packages that SwaggerEditor requires, you need to [Authenticate to GitHub Packages](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-npm-registry#authenticating-to-github-packages).
281-
282-
You can authenticate to GitHub Packages with npm by either editing your per-user *~/.npmrc*
283-
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.
284-
285-
To authenticate by adding your personal access token (classic) to your *~/.npmrc* file,
286-
edit the *~/.npmrc* file for your project to include the following line,
287-
replacing TOKEN with your personal access token. Create a new *~/.npmrc* file if one doesn't exist.
288-
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).
289-
290-
```
291-
//npm.pkg.github.com/:_authToken=TOKEN
292-
```
293-
294-
295-
Alternatively, to authenticate by logging in to npm, use the `npm login` command,
296-
replacing USERNAME with your GitHub username, TOKEN with your personal access token (classic),
297-
and PUBLIC-EMAIL-ADDRESS with your email address.
298-
299-
```sh
300-
$ npm login --scope=@swagger-api --registry=https://npm.pkg.github.com
301-
302-
> Username: USERNAME
303-
> Password: TOKEN
304-
> Email: PUBLIC-EMAIL-ADDRESS
305-
```
306-
307343
Run the following commands to set up the repository for local development:
308344
309345
```sh

0 commit comments

Comments
 (0)