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.

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

fix: resolve CI issues #163

Merged
merged 5 commits into from
Jan 1, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 5 additions & 9 deletions .github/workflows/pull-request.yml
Original file line number Diff line number Diff line change
@@ -1,24 +1,20 @@
name: 'CI'
name: "CI"
on:
pull_request:
types: [opened, reopened, synchronize]
push:
branches:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Personally I think it's nice to keep this on push because I like having the status in the commit history

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Makes sense, adding it back now :)

- main
- master

env:
NPM_VERSION: 10

jobs:
test:
runs-on: ubuntu-latest
strategy:
matrix:
node: [14, 16, 18, 20]
node: [18, 20, 22]
name: Node ${{ matrix.node }}
steps:
- name: 'Checkout latest code'
- name: "Checkout latest code"
uses: actions/checkout@v3
with:
ref: ${{ github.event.pull_request.head.sha }}
Expand All @@ -37,7 +33,7 @@ jobs:
run: npm run test

lint:
name: 'ESLint'
name: "ESLint"
runs-on: ubuntu-latest
steps:
- name: Checkout latest code
Expand All @@ -47,7 +43,7 @@ jobs:
- name: Set up node
uses: actions/setup-node@v3
with:
node-version: '16'
node-version: "22"
- name: Install dependencies
run: npm ci
- name: Run ESLint
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ Below is a table containing all of the possible configuration options for `serve

| Property | Type | Description | Default |
| -------- | ---- | ----------- | ------- |
| library | `Function` | Custom mysql library | `require('mysql')` |
| library | `Function` | Custom mysql library | `require('mysql2')` |
| promise | `Function` | Custom promise library | `Promise` |
| backoff | `String` or `Function` | Backoff algorithm to be used when retrying connections. Possible values are `full` and `decorrelated`, or you can also specify your own algorithm. See [Connection Backoff](#connection-backoff) for more information. | `full` |
| base | `Integer` | Number of milliseconds added to random backoff values. | `2` |
Expand Down Expand Up @@ -207,7 +207,7 @@ library: require('aws-sdk-xray-node')(require('mysql'));
```

### Consideration when using TypeScript
Currently, our type definitions rely on the `mysql` module.
Currently, our type definitions rely on the `mysql2` module.
In order to use a custom library, you will need to do something along the following snippet:

```typescript
Expand Down
Loading
Loading