data
data copied to clipboard
[DOC] improve linking contributor documentation
Continue polishing the documentation I introduced in #7019. We'll want to expand that because it focuses chiefly on monolithic installs and only uses yarn
. In reality people consume ember-data differently so we'll want to account for the major differences.
- [ ] generalize the language for individual packages
- [ ] yarn + npm do not mix so we need to caveat and describe this better
- see ember.js discussion. Where is this?
FYI @rwjblue @MelSumner. I figured breaking this out as a distinct issue is better than me blocking further improvement work.
fwiw you can also generate tarballs and then install those directly. That generally is better than linking as linking introduces additional errors due to dev-dependencies being installed while the build is performed for the consuming application.
The following command, run from the project root, will generate tarballs. Note if you have unsaved changes you may troll yourself, ensure any local work in ember-data is committed before generating.
node ./bin/packages-for-commit.js
This will output a list of tarballs to use once complete.
Successfully packaged commit 4b7977c46b8f2df6f5c6f87748508292de1f877c
The following packages have been generated:
✅ "ember-data": "file:/Users/runspired/github/oss/__tarball-cache/4b7977c46b8f2df6f5c6f87748508292de1f877c/ember-data-3.29.0-alpha.4-sha.4b7977c46b8f2df6f5c6f87748508292de1f877c.tgz"
✅ "@ember-data/adapter": "file:/Users/runspired/github/oss/__tarball-cache/4b7977c46b8f2df6f5c6f87748508292de1f877c/ember-data-adapter-3.29.0-alpha.4-sha.4b7977c46b8f2df6f5c6f87748508292de1f877c.tgz"
✅ "@ember-data/canary-features": "file:/Users/runspired/github/oss/__tarball-cache/4b7977c46b8f2df6f5c6f87748508292de1f877c/ember-data-canary-features-3.29.0-alpha.4-sha.4b7977c46b8f2df6f5c6f87748508292de1f877c.tgz"
✅ "@ember-data/debug": "file:/Users/runspired/github/oss/__tarball-cache/4b7977c46b8f2df6f5c6f87748508292de1f877c/ember-data-debug-3.29.0-alpha.4-sha.4b7977c46b8f2df6f5c6f87748508292de1f877c.tgz"
✅ "@ember-data/model": "file:/Users/runspired/github/oss/__tarball-cache/4b7977c46b8f2df6f5c6f87748508292de1f877c/ember-data-model-3.29.0-alpha.4-sha.4b7977c46b8f2df6f5c6f87748508292de1f877c.tgz"
✅ "@ember-data/private-build-infra": "file:/Users/runspired/github/oss/__tarball-cache/4b7977c46b8f2df6f5c6f87748508292de1f877c/ember-data-private-build-infra-3.29.0-alpha.4-sha.4b7977c46b8f2df6f5c6f87748508292de1f877c.tgz"
✅ "@ember-data/record-data": "file:/Users/runspired/github/oss/__tarball-cache/4b7977c46b8f2df6f5c6f87748508292de1f877c/ember-data-record-data-3.29.0-alpha.4-sha.4b7977c46b8f2df6f5c6f87748508292de1f877c.tgz"
✅ "@ember-data/serializer": "file:/Users/runspired/github/oss/__tarball-cache/4b7977c46b8f2df6f5c6f87748508292de1f877c/ember-data-serializer-3.29.0-alpha.4-sha.4b7977c46b8f2df6f5c6f87748508292de1f877c.tgz"
✅ "@ember-data/store": "file:/Users/runspired/github/oss/__tarball-cache/4b7977c46b8f2df6f5c6f87748508292de1f877c/ember-data-store-3.29.0-alpha.4-sha.4b7977c46b8f2df6f5c6f87748508292de1f877c.tgz"
The tarballs for these packages are available within /Users/runspired/github/oss/__tarball-cache/4b7977c46b8f2df6f5c6f87748508292de1f877c
⚠️ They may only be used on this machine.
You can then use them by adding them to the package.json
of the consuming application. The resolutions hash should also be set. You only need to add the packages the consuming application specifies in their package.json (for instance only ember-data
if ember-data
is in use)
"devDependencies": {
"ember-data": "file:/Users/runspired/github/oss/__tarball-cache/010b63c79d58e4051dd7dc559b91f8504f7a5a5d/ember-data-3.29.0-alpha.2-sha.010b63c79d58e4051dd7dc559b91f8504f7a5a5d.tgz",
},
"resolutions": {
"ember-data": "file:/Users/runspired/github/oss/__tarball-cache/010b63c79d58e4051dd7dc559b91f8504f7a5a5d/ember-data-3.29.0-alpha.2-sha.010b63c79d58e4051dd7dc559b91f8504f7a5a5d.tgz",
"@ember-data/adapter": "file:/Users/runspired/github/oss/__tarball-cache/010b63c79d58e4051dd7dc559b91f8504f7a5a5d/ember-data-adapter-3.29.0-alpha.2-sha.010b63c79d58e4051dd7dc559b91f8504f7a5a5d.tgz",
"@ember-data/canary-features": "file:/Users/runspired/github/oss/__tarball-cache/010b63c79d58e4051dd7dc559b91f8504f7a5a5d/ember-data-canary-features-3.29.0-alpha.2-sha.010b63c79d58e4051dd7dc559b91f8504f7a5a5d.tgz",
"@ember-data/debug": "file:/Users/runspired/github/oss/__tarball-cache/010b63c79d58e4051dd7dc559b91f8504f7a5a5d/ember-data-debug-3.29.0-alpha.2-sha.010b63c79d58e4051dd7dc559b91f8504f7a5a5d.tgz",
"@ember-data/model": "file:/Users/runspired/github/oss/__tarball-cache/010b63c79d58e4051dd7dc559b91f8504f7a5a5d/ember-data-model-3.29.0-alpha.2-sha.010b63c79d58e4051dd7dc559b91f8504f7a5a5d.tgz",
"@ember-data/private-build-infra": "file:/Users/runspired/github/oss/__tarball-cache/010b63c79d58e4051dd7dc559b91f8504f7a5a5d/ember-data-private-build-infra-3.29.0-alpha.2-sha.010b63c79d58e4051dd7dc559b91f8504f7a5a5d.tgz",
"@ember-data/record-data": "file:/Users/runspired/github/oss/__tarball-cache/010b63c79d58e4051dd7dc559b91f8504f7a5a5d/ember-data-record-data-3.29.0-alpha.2-sha.010b63c79d58e4051dd7dc559b91f8504f7a5a5d.tgz",
"@ember-data/serializer": "file:/Users/runspired/github/oss/__tarball-cache/010b63c79d58e4051dd7dc559b91f8504f7a5a5d/ember-data-serializer-3.29.0-alpha.2-sha.010b63c79d58e4051dd7dc559b91f8504f7a5a5d.tgz",
"@ember-data/store": "file:/Users/runspired/github/oss/__tarball-cache/010b63c79d58e4051dd7dc559b91f8504f7a5a5d/ember-data-store-3.29.0-alpha.2-sha.010b63c79d58e4051dd7dc559b91f8504f7a5a5d.tgz"
}