-
-
Notifications
You must be signed in to change notification settings - Fork 4.2k
Release Process
Kevin Ngo edited this page May 6, 2019
·
29 revisions
When builds are built, make sure the source map URLs at the bottom of the builds are correct.
- Clear and reinstall
node_modulesto make sure dependencies are up-to-date, especially for three.js. - Update CHANGELOG.md. Go through each commit in the Git log since the last release and include every notable patch. The categories should be
Major Changes,Deprecations,Enhancements,Performance,Bug Fixes. In each category, loosely sort the more impacting changes at the top. - Update version field in
package.json. Push that to GitHub so the bot can build it. Then rebase off that. - Update
prereleasecommand inpackage.jsonwith the before and after versions andnpm run prereleaseto update documentation, README.md, and build filenames with the new version. - Git tag
- Create and push documentation branch (i.e.,
docs-vx.x.0, only for major versions) - Create builds for the
dist/folder withnpm run prerelease. - Create builds for the CDN with
FOR_RELEASE=true npm run prerelease. Copy and push theseaframe.*builds to the A-Frame releases repository. npm publish- Deploy GitHub pages (
npm run ghpages). - Publish GitHub release notes, copying and pasting from CHANGELOG.md
For major versions.
- Update
aframe.current_versionin_config.prod.yml - Add new version to
multidep.jsonconfig, pointing to the documentation branch - In
package.json, update the version in thebumpdocscommand to have the bot force clean the documentation cache on each update - Publish blog post
- Update
src/_data/examples.yml
- Bump builds (
npm run dist) npm publish- Deploy GitHub pages (
npm run ghpages)
- Bump Glitches, owned by @ngokevin
- Announce on social channels