Skip to content

Commit 9f9568b

Browse files
authored
docs: fix bug in docs related to running tests (#5926)
1 parent 4e420cb commit 9f9568b

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

CONTRIBUTING.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ Before running _plugin_ tests, the supporting docker containers need to be runni
108108
109109
Instead, you can follow this procedure for the plugin you want to run tests for:
110110

111-
1. Check the CI config in `.github/workflows/plugins.yml` to see what the appropriate values for the `SERVICES` and `PLUGINS` environment variables are for the plugin you're trying to test (noting that not all plugins require `SERVICES`). For example, for the `amqplib` plugin, the `SERVICES` value is `rabbitmq`, and the `PLUGINS` value is `amqplib`.
111+
1. Check the CI config in `.github/workflows/*.yml` to see what the appropriate values for the `SERVICES` and `PLUGINS` environment variables are for the plugin you're trying to test (noting that not all plugins require `SERVICES`). For example, for the `amqplib` plugin, the `SERVICES` value is `rabbitmq`, and the `PLUGINS` value is `amqplib`.
112112
2. Run the appropriate docker-compose command to start the required services. For example, for the `amqplib` plugin, you would run: `docker compose up -d rabbitmq`.
113113
3. Run `yarn services`, with the environment variables set above. This will install any versions of the library to be tested against into the `versions` directory, and check that the appropriate services are running prior to running the test.
114114
4. Now, you can run `yarn test:plugins` with the environment variables set above to run the tests for the plugin you're interested in.
@@ -117,8 +117,8 @@ To wrap that all up into a simple few lines of shell commands, here is all of th
117117

118118
```sh
119119
# These are exported for simplicity, but you can also just set them inline.
120-
export SERVICES="rabbitmq" # retrieved from .github/workflows/plugins.yml
121-
export PLUGINS="amqplib" # retrieved from .github/workflows/plugins.yml
120+
export SERVICES="rabbitmq" # retrieved from .github/workflows/apm-integrations.yml
121+
export PLUGINS="amqplib" # retrieved from .github/workflows/apm-integrations.yml
122122

123123
docker compose up -d $SERVICES
124124
yarn services

0 commit comments

Comments
 (0)