Multigraph - Releasing Multigraph

Creating a Release of Multigraph

Be absolutely sure that you're ready to create a release; deleting a release is difficult. Before you start, be sure to:
- make sure your copy of the js-multigraph repo is on the master branch
- make sure your copy of the js-multigraph repo is up to date with the latest commits, or, if you want to create a release that is not at the head of the master branch, that it is positioned at the commit where you want to create the release
- make sure that any submodules (jermaine, error-display) are present in your js-multigraph and positioned at the correct commit for the release
- run all jasmine tests
- view all graph tests
Do all of the following steps at the same time; don't start the release process and leave it before you have finished all these steps.
Decide on a version number for the release; this is usually done by incrementing the minor verison number (the part after the decimal) by one. You can view a list of all the release tags in the repository by running the "tags" script in the top level of the js-multigraph project.
```
 cd js-multigraph
 ./tags
```
Edit the file ReleaseNotes.md in the top level directory of the js-multigraph project, to add whatever notes are pertinent to the new release. Be sure to include mention of the specific version number. Commit the change.
```
 emacs ReleaseNotes.md
 git add ReleaseNotes.md
 git commit -m 'updates ReleaseNotes.md in preparation for release 4.1'
```
Run 'npm run build-graph-tests' to rebuild the spec/graphs/graphs.json file that contains the example metadata used on the web site.
```
 npm run build-graph-tests
 git add spec
 git commit -m 'runs `npm run build-graph-tests`'
```
Run 'npm run build-all' to rebuild the built versions of Multigraph in the project; commit the results.
```
 npm run build-all
 git add build
 git commit -m 'runs `npm run build-all`'
```
Tag the release with the tag 'vM.N', where M.N is the version number, and with a log message using the -m option. For example:
```
 git tag -a v4.1 -m 'Release 4.1'
```
Push the master branch and the new tag to github
```
 git push origin master
 git push origin v4.1
```
In the multigraph.github.com repo, run the update-site script
```
 ./update-site
```
This script updates various files in the multigraph.github.com by copying content from the lib/js-multigraph submodule.

Note that update-site takes care of updating the lib/js-multigraph submodule of multigraph.github.com, including leaving it in a state with the latest release checked out.
Preview the web site by running jekyll locally. Be sure to especially check the downloads page.
```
 jekyll serve
 browse to http://localhost:4000
```

Commit the changes and push to github

 git add .
 git commit -m 'updates to js-multigraph creating release v4.1'
 git push

Deleting a Release of Multigraph

In general you should NOT delete a release, especially if it has been out long enough for anyone to have downloaded it. If you've decided that a particular release of Multigraph is bad for some reason and needs to be removed from the web so that no one will download it any more, you can flag it as bad.

Flagging a Release as Bad

This process keeps the release tag in the repository, so there is still a record of it, but removes mention of that release from the web site, and prevents the update-site script from ever including it again.

In the js-multigraph repo, create an additional tag for the release, whose name is the release tag followed by the suffix "-bad", and push the new tag to github.
```
 cd js-multigraph
 git tag -a -m 'tags v4.1 as bad' v4.1-bad v4.1 
 git push origin v4.1-bad
```
Note that it's important to use the full release tag name; for example, if the bad tag is "v4.1", you should create a tag named "v4.1-bad", not "4.1-bad".
In the multigraph.github.com repo, delete the download files associated with the bad release, and re-run the update-site script.
```
 cd multigraph-github.io
 git rm download/*-4.1.*
 ./update-site
```
Preview the web site by running jekyll locally. Be sure to especially check the downloads page.
```
 jekyll serve
 browse to http://localhost:4000
```

Commit the changes and push to github

 git add .
 git commit -m 'updates to js-multigraph marking release v4.1 as bad'
 git push

Completely Removing a Release

If you really want to completely remove a release so that there is no record of it ever having existed, you can do the following. Only do this if you are sure that no one has updated their local copy of the js-multigraph repository since the release was created; deleting a release after someone has pulled the tag into their local copy will probably cause problems. Really, the only situation in which you should do this is if you are testing the release process itself and you are sure that no one else has been using the js-multigraph repo on github since you created the release that you're deleting.

Delete the tag from your js-multigraph project, and push the deletion to github.
```
 cd js-multigraph
 git tag -d v4.1
 git push origin :refs/tags/v4.1
```
In the multigraph.github.com repo, delete the download files associated with the deleted release, and re-run the update-site script.
```
 cd multigraph-github.io
 git rm download/*-4.1.*
 ./update-site
```
Preview the web site by running jekyll locally. Be sure to especially check the downloads page.
```
 jekyll serve
              browse to http://localhost:4000
```

Commit the changes and push to github

 git add .
 git commit -m 'updates to js-multigraph deleting release v4.1'
 git push