Release Process

A-Frame

• 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
• Update prerelease command in package.json with the before and after versions and npm run prerelease to 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:min and dist:max commands to remove the -master suffix. Run npm run dist. Copy and push these aframe.* builds to the A-Frame releases repository. Also push these builds to the dist/ folder.
• Deploy GitHub pages (npm run ghpages).
• npm publish

A-Frame Site

For major versions.

• Update aframe.current_version in _config.prod.yml
• Add new version to multidep.json config, pointing to the documentation branch
• In package.json, update the version in the bumpdocs command to have the bot force clean the documentation cache on each update
• Publish blog post
• Update src/_data/examples.yml

Inspector

Coordinate with Inspector maintainers.

• Bump builds (npm run dist)
• Git tag
• Publish GitHub release notes
• npm publish
• Deploy GitHub pages (npm run ghpages)

Registry

For major versions.

• Update aframe_version in package.json
• Add the A-Frame version to scripts/build.js array

Misc

• 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)