Release Procedure

Jump to bottom

Brian Baker edited this page Mar 30, 2022 · 3 revisions

Build and Publish F2

The procedure below should be used when releasing a new version of F2:

merge the pull request into master
pull master locally
run npm version patch (or minor or major depending on the updates)
run git push && git push --tags
draft a release

Publish updates to gh-pages

The following procedure will build all docs and push them to gh-pages:

check out the repo to a gh-pages folder. this folder should be sibling of wherever F2 is normally checked out
run git checkout gh-pages
cd ../ to where F2 is normally checked out
run npm run build
run npm run docs
run npm run docs-live to verify the look of the docs via http://localhost:8080
run npm run gh-pages
run cd ../gh-pages
run git status to review what has changed and ensure it looks correct
run git add -A
run git commit -m "#.#.#"
run git push

Publish to npm

Steps below assume the user belongs to the markitondemand organization on npmjs.org.

run npm login
run npm publish
verify updates here: https://www.npmjs.com/package/f2

Other stuff

Some other stuff that can also happen:

Update Changelog in GH wiki
Post to blog.openf2.org, Twitter, Google Groups?