-
-
Notifications
You must be signed in to change notification settings - Fork 4.3k
Release Process
Kevin Ngo edited this page Oct 18, 2017
·
29 revisions
- Bump your dependencies with
npm install - 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 - Create versioned builds by modifying the
npm run dist:minandnpm run dist:maxcommands to buildaframe(e.g.,aframe.jsandaframe.min.js) vs.aframe-master. This is for source maps to be build correctly since the source map URL points to a local path. - 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
- Publish GitHub release notes, copying and pasting from CHANGELOG.md
- Create and push documentation branch (i.e.,
docs-vx.x.0, only for major versions) - Create builds for the CDN by modifying
dist:minanddist:maxcommands to remove the-mastersuffix. Runnpm run dist. Copy and push theseaframe.*builds to the A-Frame releases repository. Also push these builds to thedist/folder. - Deploy GitHub pages (
npm run ghpages). npm publish
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
Coordinate with Inspector maintainers.
- Bump builds (
npm run dist) - Git tag
- Publish GitHub release notes
npm publish- Deploy GitHub pages (
npm run ghpages)
For major versions.
- Update
aframe_versioninpackage.json - Add the A-Frame version to
scripts/build.jsarray
- Bump A-Frame CDN URL in boilerplates (
aframevr/aframe-boilerplate), CodePen, and Glitch. - Make a pull request to algolia/docsearch-configs to index documentation for search.
- Announce on social channels (Twitter, Reddit, HN, Slack)