Skip to content

Commit b1e4be1

Browse files
authored
Merge pull request #371 from matestack/sf/webpack-release-documentation
webpack: updating release documentation
2 parents e01cffb + 0e9aad7 commit b1e4be1

File tree

1 file changed

+6
-12
lines changed

1 file changed

+6
-12
lines changed

docs/contribute/README.md

Lines changed: 6 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -148,20 +148,14 @@ rails app:webdrivers:chromedriver:update
148148

149149
## Release
150150

151-
Webpacker is used for managing all JS assets. In order to deploy a packed JS, we use a "builder" app found in `repo_root/builder`. This builder app uses a symlink in order to reference the actual core found in `builder/vendor`.
152-
153-
You can run webpacker inside this builder app to pack JS assets:
151+
[Webpacker](https://github.com/rails/webpacker) is used for managing all JS assets. In order to create production-ready assets, run the [task](https://github.com/matestack/matestack-ui-core/blob/master/Rakefile)
154152

155153
```shell
156-
cd builder
157-
158-
./bin/webpack
159-
160-
#or
161-
162-
./bin/webpack --watch
154+
bin/rails webpack
163155
```
164156

165-
All webpack configuration can be found within the builder folder.
157+
from the matestack-ui-core repository root folder. The assets will be exported to [`vendor/assets/javascripts/dist`](https://github.com/matestack/matestack-ui-core/tree/master/vendor/assets/javascripts/dist).
158+
159+
Under the hood, we use a "builder" app in the [`builder`](https://github.com/matestack/matestack-ui-core/tree/master/builder) folder in order to run webpacker and create the assets. Its webpack(er) configuration can be found in [`builder/config`](https://github.com/matestack/matestack-ui-core/tree/master/builder/config).
166160

167-
For further webpacker documentation: [webpacker](https://github.com/rails/webpacker)
161+
When creating a new matestack-ui-core release, make sure to also change the version number accordingly in [`package.json`](https://github.com/matestack/matestack-ui-core/blob/master/package.json) and to create a corresponding [version tag on github](https://github.com/matestack/matestack-ui-core/tags).

0 commit comments

Comments
 (0)