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

chore: new docs regarding testing in the platforms #429

Merged
merged 1 commit into from
Sep 27, 2024
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
16 changes: 6 additions & 10 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,20 +7,16 @@ Thanks for contributing! Please read this document to follow our conventions for
- Clone the repository and run `npm install`
- Run `npm start` to start storybook

## Testing in Nancy codebase
## Testing in the platforms using linking

In order to test your changes, you will need to link the local version of the library. To do this, run the following commands:

- Make sure to have the library built by running `npx vite build`. The linked version will use the build files from _dist/_ folder.
- Make sure the `resolve.symlinks` property in you webpack config is set to `false`
- `yarn link` in the root of the library
- `yarn link @mparticle/aquarium` in the root of Nancy
- Make sure to have the library built by running `npm run build`. The linked version will use the build files from _dist/_ folder.
**A new build is required whenever you make changes** to the library code!
- `yarn link` for Nancy, `npm link` Indicative, in the root of the library
- `yarn link @mparticle/aquarium` for Nancy, `npm link @mparticle/aquarium` for Indicative in the root of the platforms
- Make sure your _/node_modules/@mparticle/aquarium_ folder contains all of the Aquarium code

## Testing in Indicative codebase

TODO

## Testing by installing from a branch

Another way to test your changes is by installing the library from a branch. To do this, we need to push the _dist/_ folder to the remote
Expand All @@ -38,7 +34,7 @@ just run the Github Action from the the branch you want to release.

### Release Process

We use semantic-release for releasing new versions of the library. You can use the Github Release Aquarium action from the `main` to release from it.
We use semantic-release for releasing new versions of the library. You can use the Github Release Aquarium action from the `main` to release from it.

> [!IMPORTANT]
> Before releasing a version from main, send a message in the #aquarium Slack channel to align it and sync on other changes that can/should be included in the release.
Expand Down
14 changes: 4 additions & 10 deletions docs/Contributing/Testing in the platforms.mdx
Original file line number Diff line number Diff line change
@@ -1,19 +1,13 @@
# Testing in the platforms

## Testing in the CDP

In order to test your changes, you will need to link the local version of the library. To do this, run the following commands:

- Make sure to have the library built by running `npx vite build`. The linked version will use the build files from _dist/_ folder.
- Make sure the `resolve.symlinks` property in you webpack config is set to `false`
- `yarn link` in the root of the library
- `yarn link @mparticle/aquarium` in the root of Nancy
- Make sure to have the library built by running `npm run build`. The linked version will use the build files from _dist/_ folder.
**A new build is required whenever you make changes** to the library code!
- `yarn link` for Nancy, `npm link` Indicative, in the root of the library
- `yarn link @mparticle/aquarium` for Nancy, `npm link @mparticle/aquarium` for Indicative in the root of the platforms
- Make sure your _/node_modules/@mparticle/aquarium_ folder contains all of the Aquarium code

## Testing in Analytics

TODO

## Testing by installing from a branch

Another way to test your changes is by installing the library from a branch. To do this, we need to push the _dist/_ folder to the remote
Expand Down
Loading
Loading