Skip to content

Commit abdf73b

Browse files
authored
add documentation note about how to add instrumentation tests to CI (#5950)
1 parent 07785fd commit abdf73b

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

CONTRIBUTING.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ should always work.
7979

8080
We use [yarn](https://yarnpkg.com/) 1.x for its workspace functionality, so make sure to install that as well. The easist way to install yarn 1.x with with npm:
8181

82-
```sh
82+
```sh
8383
$ npm install -g yarn
8484
```
8585

@@ -149,6 +149,12 @@ $ yarn test:instrumentations
149149
Several other components have test commands as well. See `package.json` for
150150
details.
151151

152+
### Adding a Plugin Test to CI
153+
154+
The plugin tests run on pull requests in Github Actions. Each plugin test suite has its own Github job, so adding a new suite to CI
155+
requires adding a new job to the Github Actions config. The file containing these configs is ``.github/workflows/apm-integrations.yml``.
156+
You can copypaste and modify an existing plugin job configuration in this file to create a new job config.
157+
152158
### Linting
153159

154160
We use [ESLint](https://eslint.org) to make sure that new code

0 commit comments

Comments
 (0)