-
-
Notifications
You must be signed in to change notification settings - Fork 4k
Release Process
Kevin Ngo edited this page Mar 9, 2018
·
29 revisions
The master build is done by @a-frobot so no need to manually build the official dist.
- Update version field in
package.json
. Push that to GitHub so the bot can build it. Then rebase off that. - 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
prerelease
command inpackage.json
with the before and after versions andnpm 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
anddist:max
commands to remove the-master
suffix. 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_version
in_config.prod.yml
- Add new version to
multidep.json
config, pointing to the documentation branch - In
package.json
, update the version in thebumpdocs
command 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
)
- Bump Glitch, owned by @ngokevin.
- Make a pull request to algolia/docsearch-configs to index documentation for search.
- Announce on social channels (Twitter, Reddit, HN, Slack)