Building the project requires Node.js installed. All current LTS versions should be supported.
The @raygun.io/aws-lambda package is at the repository root.
The example folder contains an example app showing the provider capabilities.
The recommended IDE for working on this project is Visual Studio Code.
To run tests, run npm run test or run all tests from VSCode.
To test the actual example's success and error paths against a local mock Raygun endpoint, run these commands from the repository root:
npm run prepare
npm --prefix example ci --ignore-scripts
npm run test:exampleThe example test uses a test API key and does not contact AWS or Raygun. The main test suite also checks overlapping async and callback invocations for breadcrumb and context isolation.
To check the code, run npm run eslint and npm run tseslint.
To format the code, run npm run prettier.
Instructions on how to run the example can be found in the example folder.
This section is intended for external contributors not part of the Raygun team.
Before you undertake any work, please create a ticket with your proposal, so that it can be coordinated with what we're doing.
If you're interested in contributing on a regular basis, please get in touch with the Raygun team.
Please fork the main repository from https://github.com/MindscapeHQ/raygun4node-aws-lambda into your own GitHub account.
Create a local branch off main in your fork,
named so that it explains the work in the branch.
Do not submit a PR directly from your main branch.
Submit a pull request against the main repositories' main branch.
Fill the PR template and give it a title that follows the Conventional Commits guidelines.
Wait for a review by the Raygun team. The team will leave you feedback and might ask you to do changes in your code.
Once the PR is approved, the team will merge it.