Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

deps,actions: update deps and make tweaks #75

Merged
merged 3 commits into from
Mar 23, 2023
Merged

deps,actions: update deps and make tweaks #75

merged 3 commits into from
Mar 23, 2023

Conversation

VoltrexKeyva
Copy link
Contributor

@VoltrexKeyva VoltrexKeyva commented Mar 17, 2023 •
edited
Loading

  • Update dependencies and developer dependencies to their latest versions.
  • Switch from Node-Fetch to Undici.
  • Update the GitHub Actions workflows to their latest versions.
  • Remove Node.js v12 from the testing matrix as it reached it's EoL (End-of-Life) stage, and add Node.js v16 and v18 to the testing matrix.
  • Align all examples (in README and JSDocs) to the code style of the codebase.
  • Inline JSDocs that only have a description.
  • Format the typedoc.json file and remove the usage of the minimal theme as it was removed.
  • Move the APIOptions interface to the src/typings.ts file and export it so it's shown in the documentation.
  • Bump version to 3.1.4.

@netlify
Copy link

netlify bot commented Mar 17, 2023 •
edited
Loading

✅ Deploy Preview for topgg-node-sdk-docs ready!

Name Link
🔨 Latest commit f649985
🔍 Latest deploy log https://app.netlify.com/sites/topgg-node-sdk-docs/deploys/641bc1386cb58c0008291541
😎 Deploy Preview https://deploy-preview-75--topgg-node-sdk-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

jpbberry
jpbberry requested changes Mar 17, 2023
View reviewed changes
src/structs/Api.ts Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
jpbberry
jpbberry reviewed Mar 17, 2023
View reviewed changes
typedoc.json Show resolved Hide resolved
@VoltrexKeyva
Copy link
Contributor Author

@jpbberry I've applied the suggested changes.

@VoltrexKeyva
Copy link
Contributor Author

VoltrexKeyva commented Mar 18, 2023 •
edited
Loading

Also note that I didn't update to TypeScript v5 because the TypeDoc developer dependency doesn't support it yet. TypeDoc now supports TypeScript v5.

@jpbberry
Copy link
Member

@pixxies @Galkon Hi, would you be able to look at the netlify workflow error?
https://app.netlify.com/sites/topgg-node-sdk-docs/deploys/6415135ff4aabf00082b7cae
https://app.netlify.com/sites/topgg-node-sdk-docs/settings/deploys#build-image-selection

Was the netlify org transferred?

@Galkon
Copy link

Galkon commented Mar 18, 2023

@pixxies @Galkon Hi, would you be able to look at the netlify workflow error?

https://app.netlify.com/sites/topgg-node-sdk-docs/deploys/6415135ff4aabf00082b7cae

https://app.netlify.com/sites/topgg-node-sdk-docs/settings/deploys#build-image-selection

Was the netlify org transferred?

It doesn't look like it was, let me get that sorted 😬

@VoltrexKeyva
deps,actions: update deps and make tweaks
c73595b 
- Update dependencies and developer dependencies to their latest
versions.
- Switch from Node-Fetch to Undici.
- Update the GitHub Actions workflows to their latest versions.
- Remove Node.js v12 from the testing matrix as it reached it's EoL
(End-of-Life) stage, and add Node.js v16 and v18 to the testing
matrix.
- Align all examples (in README and JSDocs) to the code style of the
codebase.
- Inline JSDocs that only have a description.
- Format the `typedoc.json` file and remove the usage of the `minimal`
theme as it was removed.
- Move the `APIOptions` interface to the `src/typings.ts` file and
export it so it's shown in the documentation.
- Bump version to 3.1.4.
@Galkon
Copy link

Galkon commented Mar 22, 2023

@jpbberry netlify deprecated the linux build image we were using, I've updated it to target Ubuntu Focal 20.04 and retried the latest deploy which didn't succeed. Maybe worth trying to trigger netlify checks again from this PR to see if they succeed with your latest commits?

Here are netlify logs, just in case:

5:23:43 PM: build-image version: a89f4ad50402ec92ae85e9b83fc50dcfb293df2e (focal)
5:23:43 PM: buildbot version: a89f4ad50402ec92ae85e9b83fc50dcfb293df2e
5:23:43 PM: Building without cache
5:23:43 PM: Starting to prepare the repo for build
5:23:43 PM: No cached dependencies found. Cloning fresh repo
5:23:43 PM: git clone --filter=blob:none https://github.com/top-gg/node-sdk
5:23:43 PM: Preparing Git Reference pull/75/head
5:23:44 PM: Parsing package.json dependencies
5:23:45 PM: Starting to install dependencies
5:23:46 PM: Downloading and installing node v12.18.0...
5:23:46 PM: Downloading https://nodejs.org/dist/v12.18.0/node-v12.18.0-linux-x64.tar.xz...
5:23:46 PM: Computing checksum with sha256sum
5:23:46 PM: Checksums matched!
5:23:47 PM: Now using node v12.18.0 (npm v6.14.4)
5:23:47 PM: Started restoring cached build plugins
5:23:47 PM: Finished restoring cached build plugins
5:23:47 PM: Started restoring cached corepack dependencies
5:23:47 PM: Finished restoring cached corepack dependencies
5:23:47 PM: No npm workspaces detected
5:23:47 PM: Started restoring cached node modules
5:23:47 PM: Finished restoring cached node modules
5:23:47 PM: Installing npm packages using npm version 6.14.4
5:23:53 PM: > @top-gg/sdk@3.1.4 prepare /opt/build/repo
5:23:53 PM: > npx husky install
5:23:53 PM: husky - Git hooks installed
5:23:53 PM: npm notice created a lockfile as package-lock.json. You should commit this file.
5:23:53 PM: npm WARN notsup Unsupported engine for @typescript-eslint/eslint-plugin@5.56.0: wanted: {"node":"^12.22.0 || ^14.17.0 || >=16.0.0"} (current: {"node":"12.18.0","npm":"6.14.4"})
5:23:53 PM: npm WARN notsup Not compatible with your version of node/npm: @typescript-eslint/eslint-plugin@5.56.0
5:23:53 PM: npm WARN notsup Unsupported engine for @typescript-eslint/parser@5.56.0: wanted: {"node":"^12.22.0 || ^14.17.0 || >=16.0.0"} (current: {"node":"12.18.0","npm":"6.14.4"})
5:23:53 PM: npm WARN notsup Not compatible with your version of node/npm: @typescript-eslint/parser@5.56.0
5:23:53 PM: npm WARN notsup Unsupported engine for eslint@8.36.0: wanted: {"node":"^12.22.0 || ^14.17.0 || >=16.0.0"} (current: {"node":"12.18.0","npm":"6.14.4"})
5:23:53 PM: npm WARN notsup Not compatible with your version of node/npm: eslint@8.36.0
5:23:53 PM: npm WARN notsup Unsupported engine for eslint-plugin-jest@27.2.1: wanted: {"node":"^14.15.0 || ^16.10.0 || >=18.0.0"} (current: {"node":"12.18.0","npm":"6.14.4"})
5:23:53 PM: npm WARN notsup Not compatible with your version of node/npm: eslint-plugin-jest@27.2.1
5:23:53 PM: npm WARN notsup Unsupported engine for husky@8.0.3: wanted: {"node":">=14"} (current: {"node":"12.18.0","npm":"6.14.4"})
5:23:53 PM: npm WARN notsup Not compatible with your version of node/npm: husky@8.0.3
5:23:53 PM: npm WARN notsup Unsupported engine for lint-staged@13.2.0: wanted: {"node":"^14.13.1 || >=16.0.0"} (current: {"node":"12.18.0","npm":"6.14.4"})
5:23:53 PM: npm WARN notsup Not compatible with your version of node/npm: lint-staged@13.2.0
5:23:53 PM: npm WARN notsup Unsupported engine for typedoc@0.23.28: wanted: {"node":">= 14.14"} (current: {"node":"12.18.0","npm":"6.14.4"})
5:23:53 PM: npm WARN notsup Not compatible with your version of node/npm: typedoc@0.23.28
5:23:53 PM: npm WARN notsup Unsupported engine for typescript@5.0.2: wanted: {"node":">=12.20"} (current: {"node":"12.18.0","npm":"6.14.4"})
5:23:53 PM: npm WARN notsup Not compatible with your version of node/npm: typescript@5.0.2
5:23:53 PM: npm WARN notsup Unsupported engine for @typescript-eslint/scope-manager@5.56.0: wanted: {"node":"^12.22.0 || ^14.17.0 || >=16.0.0"} (current: {"node":"12.18.0","npm":"6.14.4"})
5:23:53 PM: npm WARN notsup Not compatible with your version of node/npm: @typescript-eslint/scope-manager@5.56.0
5:23:53 PM: npm WARN notsup Unsupported engine for @typescript-eslint/type-utils@5.56.0: wanted: {"node":"^12.22.0 || ^14.17.0 || >=16.0.0"} (current: {"node":"12.18.0","npm":"6.14.4"})
5:23:53 PM: npm WARN notsup Not compatible with your version of node/npm: @typescript-eslint/type-utils@5.56.0
5:23:53 PM: npm WARN notsup Unsupported engine for @typescript-eslint/utils@5.56.0: wanted: {"node":"^12.22.0 || ^14.17.0 || >=16.0.0"} (current: {"node":"12.18.0","npm":"6.14.4"})
5:23:53 PM: npm WARN notsup Not compatible with your version of node/npm: @typescript-eslint/utils@5.56.0
5:23:53 PM: npm WARN notsup Unsupported engine for @typescript-eslint/types@5.56.0: wanted: {"node":"^12.22.0 || ^14.17.0 || >=16.0.0"} (current: {"node":"12.18.0","npm":"6.14.4"})
5:23:53 PM: npm WARN notsup Not compatible with your version of node/npm: @typescript-eslint/types@5.56.0
5:23:53 PM: npm WARN notsup Unsupported engine for @typescript-eslint/visitor-keys@5.56.0: wanted: {"node":"^12.22.0 || ^14.17.0 || >=16.0.0"} (current: {"node":"12.18.0","npm":"6.14.4"})
5:23:53 PM: npm WARN notsup Not compatible with your version of node/npm: @typescript-eslint/visitor-keys@5.56.0
5:23:53 PM: npm WARN notsup Unsupported engine for eslint-visitor-keys@3.3.0: wanted: {"node":"^12.22.0 || ^14.17.0 || >=16.0.0"} (current: {"node":"12.18.0","npm":"6.14.4"})
5:23:53 PM: npm WARN notsup Not compatible with your version of node/npm: eslint-visitor-keys@3.3.0
5:23:53 PM: npm WARN notsup Unsupported engine for @typescript-eslint/typescript-estree@5.56.0: wanted: {"node":"^12.22.0 || ^14.17.0 || >=16.0.0"} (current: {"node":"12.18.0","npm":"6.14.4"})
5:23:53 PM: npm WARN notsup Not compatible with your version of node/npm: @typescript-eslint/typescript-estree@5.56.0
5:23:53 PM: npm WARN notsup Unsupported engine for @eslint-community/eslint-utils@4.3.0: wanted: {"node":"^12.22.0 || ^14.17.0 || >=16.0.0"} (current: {"node":"12.18.0","npm":"6.14.4"})
5:23:53 PM: npm WARN notsup Not compatible with your version of node/npm: @eslint-community/eslint-utils@4.3.0
5:23:53 PM: npm WARN notsup Unsupported engine for @eslint/eslintrc@2.0.1: wanted: {"node":"^12.22.0 || ^14.17.0 || >=16.0.0"} (current: {"node":"12.18.0","npm":"6.14.4"})
5:23:53 PM: npm WARN notsup Not compatible with your version of node/npm: @eslint/eslintrc@2.0.1
5:23:53 PM: npm WARN notsup Unsupported engine for @eslint/js@8.36.0: wanted: {"node":"^12.22.0 || ^14.17.0 || >=16.0.0"} (current: {"node":"12.18.0","npm":"6.14.4"})
5:23:53 PM: npm WARN notsup Not compatible with your version of node/npm: @eslint/js@8.36.0
5:23:53 PM: npm WARN notsup Unsupported engine for @humanwhocodes/module-importer@1.0.1: wanted: {"node":">=12.22"} (current: {"node":"12.18.0","npm":"6.14.4"})
5:23:53 PM: npm WARN notsup Not compatible with your version of node/npm: @humanwhocodes/module-importer@1.0.1
5:23:53 PM: npm WARN notsup Unsupported engine for eslint-scope@7.1.1: wanted: {"node":"^12.22.0 || ^14.17.0 || >=16.0.0"} (current: {"node":"12.18.0","npm":"6.14.4"})
5:23:53 PM: npm WARN notsup Not compatible with your version of node/npm: eslint-scope@7.1.1
5:23:53 PM: npm WARN notsup Unsupported engine for espree@9.5.0: wanted: {"node":"^12.22.0 || ^14.17.0 || >=16.0.0"} (current: {"node":"12.18.0","npm":"6.14.4"})
5:23:53 PM: npm WARN notsup Not compatible with your version of node/npm: espree@9.5.0
5:23:53 PM: npm WARN notsup Unsupported engine for cli-truncate@3.1.0: wanted: {"node":"^12.20.0 || ^14.13.1 || >=16.0.0"} (current: {"node":"12.18.0","npm":"6.14.4"})
5:23:53 PM: npm WARN notsup Not compatible with your version of node/npm: cli-truncate@3.1.0
5:23:53 PM: npm WARN notsup Unsupported engine for commander@10.0.0: wanted: {"node":">=14"} (current: {"node":"12.18.0","npm":"6.14.4"})
5:23:53 PM: npm WARN notsup Not compatible with your version of node/npm: commander@10.0.0
5:23:53 PM: npm WARN notsup Unsupported engine for execa@7.1.1: wanted: {"node":"^14.18.0 || ^16.14.0 || >=18.0.0"} (current: {"node":"12.18.0","npm":"6.14.4"})
5:23:53 PM: npm WARN notsup Not compatible with your version of node/npm: execa@7.1.1
5:23:53 PM: npm WARN notsup Unsupported engine for listr2@5.0.8: wanted: {"node":"^14.13.1 || >=16.0.0"} (current: {"node":"12.18.0","npm":"6.14.4"})
5:23:53 PM: npm WARN notsup Not compatible with your version of node/npm: listr2@5.0.8
5:23:53 PM: npm WARN notsup Unsupported engine for yaml@2.2.1: wanted: {"node":">= 14"} (current: {"node":"12.18.0","npm":"6.14.4"})
5:23:53 PM: npm WARN notsup Not compatible with your version of node/npm: yaml@2.2.1
5:23:53 PM: npm WARN notsup Unsupported engine for human-signals@4.3.1: wanted: {"node":">=14.18.0"} (current: {"node":"12.18.0","npm":"6.14.4"})
5:23:53 PM: npm WARN notsup Not compatible with your version of node/npm: human-signals@4.3.1
5:23:53 PM: npm WARN notsup Unsupported engine for is-stream@3.0.0: wanted: {"node":"^12.20.0 || ^14.13.1 || >=16.0.0"} (current: {"node":"12.18.0","npm":"6.14.4"})
5:23:53 PM: npm WARN notsup Not compatible with your version of node/npm: is-stream@3.0.0
5:23:53 PM: npm WARN notsup Unsupported engine for npm-run-path@5.1.0: wanted: {"node":"^12.20.0 || ^14.13.1 || >=16.0.0"} (current: {"node":"12.18.0","npm":"6.14.4"})
5:23:53 PM: npm WARN notsup Not compatible with your version of node/npm: npm-run-path@5.1.0
5:23:53 PM: added 282 packages from 222 contributors and audited 283 packages in 5.162s
5:23:53 PM: 67 packages are looking for funding
5:23:53 PM:   run `npm fund` for details
5:23:53 PM: found 0 vulnerabilities
5:23:53 PM: npm packages installed
5:23:53 PM: Python version set to 3.8
5:23:53 PM: Started restoring cached go cache
5:23:53 PM: Finished restoring cached go cache
5:23:53 PM: Installing Go version 1.19.5 (requested 1.19.5)
5:23:58 PM: go version go1.19.5 linux/amd64
5:23:58 PM: go version go1.19.5 linux/amd64
5:23:59 PM: go version go1.19.5 linux/amd64
5:23:59 PM: go version go1.19.5 linux/amd64
5:23:59 PM: go version go1.19.5 linux/amd64
5:23:59 PM: go version go1.19.5 linux/amd64
5:23:59 PM: Attempting Ruby version 2.7.2, read from environment
5:24:00 PM: Using Ruby version 2.7.2
5:24:00 PM: go version go1.19.5 linux/amd64
5:24:00 PM: go version go1.19.5 linux/amd64
5:24:01 PM: go version go1.19.5 linux/amd64
5:24:01 PM: Using PHP version 8.0
5:24:01 PM: Install dependencies script success
5:24:01 PM: Starting build script
5:24:01 PM: Using stage install dependencies
5:24:01 PM: go version go1.19.5 linux/amd64
5:24:01 PM: Detected 0 framework(s)
5:24:01 PM: Section completed: initializing
5:24:03 PM: ​
5:24:03 PM:   Netlify Build                                                 
5:24:03 PM: ────────────────────────────────────────────────────────────────
5:24:03 PM: ​
5:24:03 PM: ❯ Version
5:24:03 PM:   @netlify/build 29.7.1
5:24:03 PM: ​
5:24:03 PM: ❯ Flags
5:24:03 PM:   baseRelDir: true
5:24:03 PM:   buildId: 641b8dfa28ee2f28a0e9f19a
5:24:03 PM:   deployId: 641b8dfa28ee2f28a0e9f19c
5:24:03 PM: ​
5:24:03 PM: ❯ Current directory
5:24:03 PM:   /opt/build/repo
5:24:03 PM: ​
5:24:03 PM: ❯ Config file
5:24:03 PM:   No config file was defined: using default values.
5:24:03 PM: ​
5:24:03 PM: ❯ Context
5:24:03 PM:   deploy-preview
5:24:03 PM: ​
5:24:03 PM:   1. Build command from Netlify app                             
5:24:03 PM: ────────────────────────────────────────────────────────────────
5:24:03 PM: ​
5:24:03 PM: $ npm run docs
5:24:03 PM: > @top-gg/sdk@3.1.4 docs /opt/build/repo
5:24:03 PM: > typedoc
5:24:03 PM: /opt/build/repo/node_modules/typedoc/dist/lib/application.js:187
5:24:03 PM:             typescript_1.default.sys.clearScreen?.();
5:24:03 PM:                                                  ^
5:24:03 PM: SyntaxError: Unexpected token '.'
5:24:03 PM:     at wrapSafe (internal/modules/cjs/loader.js:1054:16)
5:24:03 PM:     at Module._compile (internal/modules/cjs/loader.js:1102:27)
5:24:03 PM:     at Object.Module._extensions..js (internal/modules/cjs/loader.js:1158:10)
5:24:03 PM:     at Module.load (internal/modules/cjs/loader.js:986:32)
5:24:03 PM:     at Function.Module._load (internal/modules/cjs/loader.js:879:14)
5:24:03 PM:     at Module.require (internal/modules/cjs/loader.js:1026:19)
5:24:03 PM:     at require (internal/modules/cjs/helpers.js:72:18)
5:24:03 PM:     at Object.<anonymous> (/opt/build/repo/node_modules/typedoc/dist/index.js:21:21)
5:24:03 PM:     at Module._compile (internal/modules/cjs/loader.js:1138:30)
5:24:03 PM:     at Object.Module._extensions..js (internal/modules/cjs/loader.js:1158:10)
5:24:03 PM: npm ERR! code ELIFECYCLE
5:24:03 PM: npm ERR! errno 1
5:24:03 PM: npm ERR! @top-gg/sdk@3.1.4 docs: `typedoc`
5:24:03 PM: npm ERR! Exit status 1
5:24:03 PM: npm ERR!
5:24:03 PM: npm ERR! Failed at the @top-gg/sdk@3.1.4 docs script.
5:24:03 PM: npm ERR! This is probably not a problem with npm. There is likely additional logging output above.
5:24:04 PM: Failed during stage 'building site': Build script returned non-zero exit code: 2 (https://ntl.fyi/exit-code-2)
5:24:03 PM: npm ERR! A complete log of this run can be found in:
5:24:03 PM: npm ERR!     /opt/buildhome/.npm/_logs/2023-03-22T23_24_03_251Z-debug.log
5:24:03 PM: ​
5:24:03 PM:   "build.command" failed                                        
5:24:03 PM: ────────────────────────────────────────────────────────────────
5:24:03 PM: ​
5:24:03 PM:   Error message
5:24:03 PM:   Command failed with exit code 1: npm run docs (https://ntl.fyi/exit-code-1)
5:24:03 PM: ​
5:24:03 PM:   Error location
5:24:03 PM:   In Build command from Netlify app:
5:24:03 PM:   npm run docs
5:24:03 PM: ​
5:24:03 PM:   Resolved config
5:24:03 PM:   build:
5:24:03 PM:     command: npm run docs
5:24:03 PM:     commandOrigin: ui
5:24:03 PM:     environment:
5:24:03 PM:       - REVIEW_ID
5:24:03 PM:     publish: /opt/build/repo/docs
5:24:03 PM:     publishOrigin: ui
5:24:03 PM: Caching artifacts
5:24:03 PM: Started saving node modules
5:24:03 PM: Finished saving node modules
5:24:03 PM: Started saving build plugins
5:24:03 PM: Finished saving build plugins
5:24:03 PM: Started saving corepack cache
5:24:03 PM: Finished saving corepack cache
5:24:03 PM: Started saving pip cache
5:24:03 PM: Finished saving pip cache
5:24:03 PM: Started saving emacs cask dependencies
5:24:03 PM: Finished saving emacs cask dependencies
5:24:03 PM: Started saving maven dependencies
5:24:03 PM: Finished saving maven dependencies
5:24:03 PM: Started saving boot dependencies
5:24:03 PM: Finished saving boot dependencies
5:24:03 PM: Started saving rust rustup cache
5:24:03 PM: Finished saving rust rustup cache
5:24:03 PM: Started saving go dependencies
5:24:03 PM: Finished saving go dependencies
5:24:04 PM: Build failed due to a user error: Build script returned non-zero exit code: 2
5:24:04 PM: Failing build: Failed to build site
5:24:05 PM: Finished processing build request in 21.987s

@jpbberry
Copy link
Member

Looks to be working, thanks Galkon!

@jpbberry jpbberry merged commit cc14fb8 into Top-gg-Community:master Mar 23, 2023
@jpbberry jpbberry mentioned this pull request Mar 23, 2023
Closed
@VoltrexKeyva VoltrexKeyva deleted the deps-and-tweaks branch March 23, 2023 09:10
This was referenced Sep 13, 2024
Open
Open
Open
Open
Open
@MaximKing1 MaximKing1 mentioned this pull request Sep 20, 2024
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jpbberry jpbberry jpbberry approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@VoltrexKeyva @jpbberry @Galkon