Skip to content

Commit

Permalink
docs(contributing): add notes about testing local changes
Browse files Browse the repository at this point in the history
Fixes #4240
  • Loading branch information
Julien Castelain committed Sep 2, 2021
1 parent bfd0435 commit f8d477d
Showing 1 changed file with 33 additions and 0 deletions.
33 changes: 33 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ Here's a set of guidelines to contribute to Clay and its packages. Use your comm
- [Additional Notes](#additional-notes)
- [Issue Labels](#issue-labels)
- [Release process](#release-process)
- [Testing local changes in liferay-portal](#testing-local-changes-in-liferay-portal)

## What Should I Know Before I Get Started?

Expand Down Expand Up @@ -347,3 +348,35 @@ cd {PORTAL_ROOT}/modules

# Lastly, share the release information in our public Slack channel!
```

## Testing local changes in liferay-portal

When working on an issue, you might want to test your changes before submitting
a pull request.

To test your changes in a liferay-portal (>= 7.3.x) environment you first need
to link the desired packages.

```bash
# Let's assume you have made a change in the clay-button component

# From the root of the clay repository, run
yarn workspace @clayui/button build
yarn workspace @clayui/buttom link

# Note that if you have linked this package before, yarn will print a warning
# but that doesn't mean that this step failed

# Now navigate to the frontend-taglib-clay module
cd {PORTAL_ROOT}/modules/apps/frontend-taglib/frontend-taglib-clay

# Link the @clayui/button package
yarn link @clayui/button

# Before deploying you shoud stop tomcat

# Deploy the module
gradlew deploy -a

# Restart tomcat
```

0 comments on commit f8d477d

Please sign in to comment.